TakeV/spacemacs
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/doc/DOCUMENTATION.org

4019 lines
220 KiB
Org Mode
Raw Normal View History

Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+TITLE: Spacemacs documentation
Switch to the new layers generator
2019-05-07 20:05:06 +00:00
* Table of Contents :TOC_5_gh:noexport:
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#core-pillars][Core Pillars]]
- [[#mnemonic][Mnemonic]]
- [[#discoverable][Discoverable]]
- [[#consistent][Consistent]]
- [[#crowd-configured][Crowd-Configured]]
- [[#highlighted-features][Highlighted features]]
- [[#screenshots][Screenshots]]
- [[#who-can-benefit-from-this][Who can benefit from this?]]
- [[#update-and-rollback][Update and Rollback]]
- [[#update-spacemacs-repository][Update Spacemacs repository]]
- [[#automatic-updates][Automatic Updates]]
- [[#updating-from-the-spacemacs-buffer][Updating from the Spacemacs Buffer]]
- [[#updating-manually-with-git][Updating Manually with git]]
- [[#update-packages][Update packages]]
- [[#configuration-layers][Configuration layers]]
- [[#purpose][Purpose]]
- [[#structure][Structure]]
- [[#configure-packages][Configure packages]]
- [[#with-a-layer][With a layer]]
- [[#declaration][Declaration]]
- [[#initialization][Initialization]]
- [[#exclusion][Exclusion]]
Add to docs, replacing a layer package with a local version When contributing to packages it is often handy to replace a package, already installed and configured by some layer with a local version of the package (i.e. a git repo). This commit adds instructions for how to achieve that.
2021-03-16 21:31:39 +00:00
- [[#overriding-a-layer-package][Overriding a layer package]]
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#without-a-layer][Without a layer]]
- [[#packages-synchronization][Packages synchronization]]
- [[#types-of-configuration-layers][Types of configuration layers]]
- [[#submitting-a-configuration-layer-upstream][Submitting a configuration layer upstream]]
- [[#example-themes-megapack-example][Example: Themes Megapack example]]
- [[#managing-private-configuration-layers][Managing private configuration layers]]
- [[#using-the-private-directory][Using the private directory]]
- [[#using-an-external-git-repository][Using an external Git repository]]
- [[#using-a-personal-branch][Using a personal branch]]
- [[#tips-for-writing-layers][Tips for writing layers]]
- [[#dotfile-configuration][Dotfile Configuration]]
- [[#dotfile-installation][Dotfile Installation]]
- [[#alternative-dotdirectory][Alternative dotdirectory]]
- [[#synchronization-of-dotfile-changes][Synchronization of dotfile changes]]
- [[#testing-the-dotfile][Testing the dotfile]]
- [[#dotfile-contents][Dotfile Contents]]
- [[#configuration-functions][Configuration functions]]
- [[#custom-variables][Custom variables]]
- [[#declaring-configuration-layers][Declaring Configuration layers]]
- [[#setting-configuration-layers-variables][Setting configuration layers variables]]
- [[#disabling-layer-services-in-other-layers][Disabling layer services in other layers]]
- [[#selectingignoring-packages-of-a-layer][Selecting/Ignoring packages of a layer]]
- [[#excluding-packages][Excluding packages]]
- [[#concepts][Concepts]]
- [[#editing-styles][Editing Styles]]
- [[#vim][Vim]]
- [[#emacs][Emacs]]
- [[#hybrid][Hybrid]]
- [[#states][States]]
- [[#evilified-modes][Evilified modes]]
- [[#evil-leader][Evil leader]]
- [[#universal-argument][Universal argument]]
- [[#transient-states][Transient-states]]
core: add support for major mode specific toggles Modify macro spacemacs|add-toggle to create additional sets of functions for each supported modes when the toggle is major mode specific. A toggle is major mode specific when it is bound to keys using the keyword :evil-leader-for-mode Updare documentation to add a section on toggles in the Spacemacs concepts.
2018-01-04 05:03:22 +00:00
- [[#toggles][Toggles]]
- [[#configuring-toggles-in-the-dotfile][Configuring toggles in the dotfile]]
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#differences-between-vim-evil-and-spacemacs][Differences between Vim, Evil and Spacemacs]]
- [[#the-vim-surround-case][The vim-surround case]]
- [[#evil-plugins][Evil plugins]]
core: rework environment variables and PATH management See updated DOCUMENTATION.org and FAQ.org for more info. * add core-env.el * add library load-env-vars.el * add bootstrap package dotenv-mode.el * remove spacemacs-environment from bootstrap layer * remove dotspacemacs variable dotspacemacs-import-env-vars-from-shell * remove dotspacemacs variable dotspacemacs-improt-env-vars-shell-file-name * add new key binding SPC f e e to open spacemacs.env file * add new key binding SPC f e E to reload environment variable from env file * add new key binding SPC f e C-e to re-initialize the env file from shell.
2018-06-25 06:16:27 +00:00
- [[#environment-variables-and-path][Environment variables and PATH]]
core: update environment variables management * add new dotfile function `dotspacemacs/user-env` * add ignored env. vars with variable spacemacs-ignored-environment-variables * ignore env vars: SSH_AUTH_SOCK and DBUS_SESSION_BUS_ADDRESS * update documentation in DOCUMENTATION.org * update .spacemacs.template with new function * rename environment file from spacemacs.env to .spacemacs.env * move location of .spacemacs.env file to home or dotdirectory * add a header to the generated .spacemacs.env file to explain what it is * make SPC f e e fallbacks to the function dotspacemacs/user-env if the user manages the env var by themselves * make SPC f e E call the new function dotspacemacs/user-env * sort environment variables in .spacemacs.env file
2018-07-03 05:20:06 +00:00
- [[#default-behavior][Default behavior]]
- [[#managing-environment-variables-by-yourself][Managing environment variables by yourself]]
- [[#note-about-the-function-dotspacemacsuser-env][Note about the function dotspacemacs/user-env]]
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#binding-keys][Binding keys]]
- [[#gui-elements][GUI Elements]]
- [[#color-themes][Color themes]]
- [[#default-theme][Default theme]]
- [[#choosing-themes][Choosing themes]]
Update themes transient state, t for helm-themes Add the key binding: t to open helm-themes, without having to use the arrow up key. Reorder/rename: cycles backward and cycles forward to: next and previous Next is listed first, because it's the most common action, and it matches the order in other transient states. Change the t argument in the call to spacemacs/cycle-spacemacs-theme, to the symbol 'backward, to make it clear what the argument does. Add documentation for the Themes Transient State bindings.
2017-10-20 12:20:26 +00:00
- [[#themes-transient-state][Themes Transient State]]
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#browsing-themes][Browsing themes]]
- [[#notes][Notes]]
- [[#font][Font]]
- [[#gui-toggles][GUI Toggles]]
Format docs
2017-12-31 00:39:19 +00:00
- [[#global-line-numbers][Global line numbers]]
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#mode-line][Mode-line]]
core: add support for mode-line themes New layer variable `dotspacemacs-mode-line-themes`: Set the theme for the Spaceline. Supported themes are `spacemacs', `all-the-icons', `custom', `vim-powerline' and `vanilla'. The first three are spaceline themes. `vanilla' is default Emacs mode-line. `custom' is a user defined themes, refer to the DOCUMENTATION.org for more info on how to create your own spaceline theme." See DOCUMENTATION.org changes for more info. This commit adds support for `spaceline-all-the-icons` package.
2018-01-12 04:53:44 +00:00
- [[#mode-line-themes][Mode-line themes]]
Add properties for mode-line theme, remove powerline-scale Since we have now a variable for the mode-line theme, it makes sense to move the scaling of the mode-line to this variable. Thus the property =:powerline-scale= of variable dotspacemacs-default-font has been removed and it is replace by the property =:separator-scale= used in the variable =dotspacemacs-mode-line-theme=. This commit also adds a the property =:sperator= for the variable =dotspacemacs-mode-line-theme= which allows to set the separator type. Example of the final result: dotspacemacs-mode-line-theme '(all-the-icons :separator cup :separator-scale 1.5) Documentation has been updated to reflect the changes.
2018-01-17 03:59:29 +00:00
- [[#separators][Separators]]
- [[#separator-scale][Separator scale]]
core: add support for mode-line themes New layer variable `dotspacemacs-mode-line-themes`: Set the theme for the Spaceline. Supported themes are `spacemacs', `all-the-icons', `custom', `vim-powerline' and `vanilla'. The first three are spaceline themes. `vanilla' is default Emacs mode-line. `custom' is a user defined themes, refer to the DOCUMENTATION.org for more info on how to create your own spaceline theme." See DOCUMENTATION.org changes for more info. This commit adds support for `spaceline-all-the-icons` package.
2018-01-12 04:53:44 +00:00
- [[#spacemacs-mode-line-theme][Spacemacs mode-line theme]]
- [[#flycheck-integration][Flycheck integration]]
- [[#anzu-integration][Anzu integration]]
- [[#battery-status-integration][Battery status integration]]
doc: mention fonts to install for all-the-icons mode-line theme
2018-01-12 05:02:05 +00:00
- [[#all-the-icons-theme][All-the-Icons theme]]
core: add support for mode-line themes New layer variable `dotspacemacs-mode-line-themes`: Set the theme for the Spaceline. Supported themes are `spacemacs', `all-the-icons', `custom', `vim-powerline' and `vanilla'. The first three are spaceline themes. `vanilla' is default Emacs mode-line. `custom' is a user defined themes, refer to the DOCUMENTATION.org for more info on how to create your own spaceline theme." See DOCUMENTATION.org changes for more info. This commit adds support for `spaceline-all-the-icons` package.
2018-01-12 04:53:44 +00:00
- [[#custom-spaceline-theme][Custom spaceline theme]]
doc: further tweaks of mode-line section
2018-01-12 05:06:50 +00:00
- [[#minor-modes][Minor Modes]]
Add j and k to transient states It is nicer when user can stay in the "home row" for basic operations like zooming in and out Font Scaling Transient State `k` scale up `j` scale down Frame Transparency Transient State `k` increase transparency `j` decrease transparency Zoom Frame Transient State `k` zoom frame in `j` zoom frame out Added two additional Zoom Frame TS keys: `m` max frame `f` fullscreen
2018-08-25 02:23:13 +00:00
- [[#frame][Frame]]
- [[#title][Title]]
- [[#iconified-tabified-title][Iconified (tabified) title]]
- [[#transparency][Transparency]]
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#layouts-and-workspaces][Layouts and workspaces]]
- [[#layouts][Layouts]]
- [[#the-default-layout][The default layout]]
- [[#project-layouts][Project layouts]]
- [[#custom-layouts][Custom Layouts]]
- [[#saveload-layouts-into-a-file][Save/Load layouts into a file]]
- [[#layout-key-bindings][Layout key bindings]]
Move doc for layout restriction and SPC TAB to DOCUMENTATION.org
2019-08-20 04:54:41 +00:00
- [[#behavior-of-spc-tab-with-layouts][Behavior of SPC TAB with layouts]]
- [[#restrict-a-given-function-to-the-current-layout][Restrict a given function to the current layout]]
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#workspaces][Workspaces]]
- [[#workspace-key-bindings][Workspace key bindings]]
- [[#commands][Commands]]
- [[#vim-key-bindings][Vim key bindings]]
- [[#escaping][Escaping]]
- [[#executing-vim-and-emacs-exm-x-commands][Executing Vim and Emacs ex/M-x commands]]
- [[#leader-key][Leader key]]
- [[#major-mode-leader-key][Major Mode leader key]]
- [[#additional-text-objects][Additional text objects]]
- [[#reserved-prefix-command-for-user][Reserved prefix command for user]]
- [[#completion][Completion]]
- [[#discovering][Discovering]]
- [[#key-bindings][Key bindings]]
- [[#which-key][Which-key]]
Add toggles for specific persistent which-key keymaps Sometimes it is handy to show keymaps persistently with which-key. For example, to show navigation commands in Info-mode, gnus, eww etc. This PR implements handy toggles and documentation for that.
2021-01-08 20:27:08 +00:00
- [[#which-key-persistent][Which-key persistent]]
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#describe-key-bindings][Describe key bindings]]
- [[#getting-help][Getting help]]
- [[#available-layers][Available layers]]
- [[#available-packages-in-spacemacs][Available packages in Spacemacs]]
- [[#new-packages-from-elpa-repositories][New packages from ELPA repositories]]
core: add support for major mode specific toggles Modify macro spacemacs|add-toggle to create additional sets of functions for each supported modes when the toggle is major mode specific. A toggle is major mode specific when it is bound to keys using the keyword :evil-leader-for-mode Updare documentation to add a section on toggles in the Spacemacs concepts.
2018-01-04 05:03:22 +00:00
- [[#toggles-1][Toggles]]
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#navigating][Navigating]]
- [[#pointcursor][Point/Cursor]]
- [[#smooth-scrolling][Smooth scrolling]]
- [[#vim-motions-with-avy][Vim motions with avy]]
- [[#ace-link-mode][ace-link mode]]
- [[#unimpaired-bindings][Unimpaired bindings]]
- [[#jumping-joining-and-splitting][Jumping, Joining and Splitting]]
- [[#jumping][Jumping]]
- [[#joining-and-splitting][Joining and splitting]]
- [[#window-manipulation][Window manipulation]]
- [[#window-manipulation-key-bindings][Window manipulation key bindings]]
Update transient state wording, etc. - Removed the word `Manipulation` from the transient state titles: - Buffer Manipulation Transient State and Window Manipulation TS - Expanded the TS abbreviation to Transient State - Documented the Buffer Transient State key binding: `q` to quit the transient state - Capitalized `Transient State` in the titles - Window Transient State: - Added a line break after the title in the folded hint. This allows for more keys to be visible horizontally. - Moved up the [?] help key after the title, so that it's in the same place in both the folded and full transient state.
2019-11-06 19:14:34 +00:00
- [[#window-transient-state][Window transient state]]
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#golden-ratio][Golden ratio]]
- [[#buffers-and-files][Buffers and Files]]
- [[#buffers-manipulation-key-bindings][Buffers manipulation key bindings]]
- [[#create-a-new-empty-buffer][Create a new empty buffer]]
Update transient state wording, etc. - Removed the word `Manipulation` from the transient state titles: - Buffer Manipulation Transient State and Window Manipulation TS - Expanded the TS abbreviation to Transient State - Documented the Buffer Transient State key binding: `q` to quit the transient state - Capitalized `Transient State` in the titles - Window Transient State: - Added a line break after the title in the folded hint. This allows for more keys to be visible horizontally. - Moved up the [?] help key after the title, so that it's in the same place in both the folded and full transient state.
2019-11-06 19:14:34 +00:00
- [[#buffers-transient-state][Buffers transient state]]
- [[#file-manipulation-key-bindings][File manipulation key bindings]]
Added frame manipulation commands
2017-02-03 21:19:04 +00:00
- [[#frame-manipulation-key-bindings][Frame manipulation key bindings]]
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#emacs-and-spacemacs-files][Emacs and Spacemacs files]]
- [[#browsing-files-in-completion-buffer][Browsing files in completion buffer]]
[visual][popwin] add keybiding to resume last popwin buffer bind it to `spc r w`
2020-10-26 06:42:18 +00:00
- [[#popup-buffers][Popup buffers]]
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#ido][Ido]]
- [[#ido-transient-state][Ido transient state]]
- [[#bookmarks][Bookmarks]]
- [[#docview-mode][DocView mode]]
- [[#auto-saving][Auto-saving]]
- [[#frequency-of-auto-saving][Frequency of auto-saving]]
- [[#location-of-auto-saved-files][Location of auto-saved files]]
- [[#disable-auto-save][Disable auto-save]]
- [[#searching][Searching]]
- [[#with-an-external-tool][With an external tool]]
- [[#useful-key-bindings][Useful key bindings]]
- [[#searching-in-current-file][Searching in current file]]
- [[#searching-in-all-open-buffers-visiting-files][Searching in all open buffers visiting files]]
- [[#searching-in-files-in-an-arbitrary-directory][Searching in files in an arbitrary directory]]
Implement helm-dir-search This is equivalent to helm-file-search with the current directory as the scope
2017-06-19 19:17:12 +00:00
- [[#searching-in-current-directory][Searching in current directory]]
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#searching-in-a-project][Searching in a project]]
- [[#searching-the-web][Searching the web]]
- [[#persistent-highlighting][Persistent highlighting]]
- [[#highlight-current-symbol][Highlight current symbol]]
- [[#visual-star][Visual Star]]
- [[#listing-symbols-by-semantic][Listing symbols by semantic]]
- [[#editing][Editing]]
- [[#paste-text][Paste text]]
Update transient state wording, etc. - Removed the word `Manipulation` from the transient state titles: - Buffer Manipulation Transient State and Window Manipulation TS - Expanded the TS abbreviation to Transient State - Documented the Buffer Transient State key binding: `q` to quit the transient state - Capitalized `Transient State` in the titles - Window Transient State: - Added a line break after the title in the folded hint. This allows for more keys to be visible horizontally. - Moved up the [?] help key after the title, so that it's in the same place in both the folded and full transient state.
2019-11-06 19:14:34 +00:00
- [[#paste-transient-state][Paste transient state]]
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#auto-indent-pasted-text][Auto-indent pasted text]]
- [[#text-manipulation-commands][Text manipulation commands]]
Replace move-text with drag-stuff Just like: https://github.com/emacsfodder/move-text https://github.com/rejeep/drag-stuff.el also drags one or more (region) lines up or down. But it also allows for dragging left and right (across end of lines): - a word: changing place with the next or previous word. - a region: moving it one character at a time to the left or right. Added a new key binding: `SPC x .` that opens the: ``` Drag Stuff Transient State [k/K] up [h/H] left [q] quit [j/J] down [l/L] right ``` The `move-text` package isn't removed, even though it isn't used anymore in Spacemacs. Because the `evil-unimpaired` elpa directory is generated from the local Spacemacs `evil-unimpaired.el` file. https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Bspacemacs/spacemacs-evil/local/evil-unimpaired/evil-unimpaired.el Therefore the `evil-unimpaired` key bindings `[e` and `]e` still call the `move-text` commands. Until the `evil-unimpaired` elpa directory has been removed and regenerated by restarting Spacemacs. Then they will call the new `drag-stuff` commands. I don't know if/when the `move-text` package can be removed in the future.
2021-03-02 16:07:57 +00:00
- [[#drag-stuff-transient-state][Drag stuff transient state]]
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#text-insertion-commands][Text insertion commands]]
- [[#smartparens-strict-mode][Smartparens Strict mode]]
- [[#zooming][Zooming]]
- [[#text][Text]]
Add j and k to transient states It is nicer when user can stay in the "home row" for basic operations like zooming in and out Font Scaling Transient State `k` scale up `j` scale down Frame Transparency Transient State `k` increase transparency `j` decrease transparency Zoom Frame Transient State `k` zoom frame in `j` zoom frame out Added two additional Zoom Frame TS keys: `m` max frame `f` fullscreen
2018-08-25 02:23:13 +00:00
- [[#frame-1][Frame]]
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#increasedecrease-numbers][Increase/Decrease numbers]]
- [[#spell-checking][Spell checking]]
- [[#region-selection][Region selection]]
- [[#expand-region][Expand-region]]
- [[#indent-text-object][Indent text object]]
- [[#region-narrowing][Region narrowing]]
- [[#replacing-text-with-iedit][Replacing text with iedit]]
- [[#iedit-states-key-bindings][iedit states key bindings]]
Switch to the new layers generator
2019-05-07 20:05:06 +00:00
- [[#state-transitions][State transitions]]
- [[#in-iedit-state][In iedit state]]
- [[#in-iedit-insert-state][In iedit-insert state]]
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#examples][Examples]]
- [[#replacing-text-in-several-files][Replacing text in several files]]
- [[#renaming-files-in-a-directory][Renaming files in a directory]]
- [[#commenting][Commenting]]
- [[#regular-expressions][Regular expressions]]
- [[#deleting-files][Deleting files]]
- [[#editing-lisp-code][Editing Lisp code]]
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
- [[#lisp-key-bindings][Lisp Key bindings]]
Switch to the new layers generator
2019-05-07 20:05:06 +00:00
- [[#lisp-state-key-bindings][Lisp state key bindings]]
- [[#emacs-lisp-specific-key-bindings][Emacs lisp specific key bindings]]
[base] Refactor keyboard macro key bindings
2020-02-23 14:40:01 +00:00
- [[#keyboard-macros][Keyboard macros]]
- [[#vim-keyboard-macros][Vim keyboard macros]]
- [[#emacs-keyboard-macros][Emacs keyboard macros]]
- [[#macro-counter][Macro counter]]
- [[#key-bindings-1][Key bindings]]
Add persistent-scratch and unkillable-scratch into core/spacemacs-editing layer (#14115)
2020-11-14 09:02:51 +00:00
- [[#scratch-buffer][Scratch buffer]]
- [[#persistent-scratch][Persistent scratch]]
- [[#unkillable-scratch][Unkillable scratch]]
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#mouse-usage][Mouse usage]]
[default] Move ediff key bindings from SPC E to SPC D prefix And add documentation
2020-02-01 21:26:08 +00:00
- [[#comparing-diff][Comparing (diff)]]
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#managing-projects][Managing projects]]
- [[#registers][Registers]]
- [[#errors-handling][Errors handling]]
Add 'z' recenter bindings for various transient states By analogy with the "zz", "zb", "zt" vim / evil bindings, this adds an additional key binding "z" for `recenter-top-bottom` to the following transient states which navigate around the buffer in large jumps: - auto-symbol-highlight - error - buffer - vcs - org-babel This allows for repositioning of the buffer for visibility without having to exit the transient state. Minor updates are also made to documentation of other transient states.
2018-10-22 08:09:55 +00:00
- [[#error-transient-state][Error transient state]]
- [[#custom-fringe-bitmaps][Custom fringe bitmaps]]
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#compiling][Compiling]]
[defaults] add qickrun bind it to `SPC x x`, not sure it's the right place but it's easy to invoke
2021-04-12 04:47:02 +00:00
- [[#quickrun][Quickrun]]
[docs] Mention EditorConfig support Fixes #8960
2017-05-25 19:20:03 +00:00
- [[#editorconfig][EditorConfig]]
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#emacs-server][Emacs Server]]
- [[#connecting-to-the-emacs-server][Connecting to the Emacs server]]
- [[#keeping-the-server-alive][Keeping the server alive]]
- [[#troubleshoot][Troubleshoot]]
- [[#loading-fails][Loading fails]]
- [[#upgradingdowngrading-emacs-version][Upgrading/Downgrading Emacs version]]
[doc] Add more detailed troubleshooting information
2019-08-28 21:53:26 +00:00
- [[#general-layer-errors][General layer errors]]
- [[#step-by-step-instructions-for-minimal-layer-bug-reports][Step by step instructions for minimal layer bug reports]]
- [[#general-emacs-package-errors][General emacs package errors]]
documentation formatting: Thu Aug 29 23:13:44 UTC 2019
2019-08-29 23:13:44 +00:00
- [[#step-by-step-instructions-for-minimal-emacs-package-bug-reports][Step by step instructions for minimal emacs package bug reports]]
update docs to the new toc-org format
2017-05-22 14:16:12 +00:00
- [[#achievements][Achievements]]
- [[#issues][Issues]]
- [[#merged-pull-requests][Merged Pull Requests]]
- [[#stars-forks-and-watchers][Stars, forks and watchers]]
- [[#gitter-chat][Gitter chat]]
- [[#first-times][First times]]
- [[#special-mentions][Special Mentions]]
- [[#special-titles][Special Titles]]
- [[#thank-you][Thank you]]
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
* Core Pillars
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
Four core pillars: Mnemonic, Discoverable, Consistent and "Crowd-Configured".
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
If any of these core pillars are violated, open an issue and we'll try our best
Doc: rewrite core pillars to be straight to the point
2016-01-03 17:57:34 +00:00
to fix it.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
** Mnemonic
Doc: rewrite core pillars to be straight to the point
2016-01-03 17:57:34 +00:00
Key bindings are organized using mnemonic prefixes like ~b~ for buffer, ~p~ for
Add small, non-structural fixes to documentation
2016-04-23 06:33:55 +00:00
project, ~s~ for search, ~h~ for help, etc...
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Fix grammar to be more consistent and discoverable
2015-11-12 11:48:19 +00:00
** Discoverable
Doc: rewrite core pillars to be straight to the point
2016-01-03 17:57:34 +00:00
Innovative real-time display of available key bindings. Simple query
Add small, non-structural fixes to documentation
2016-04-23 06:33:55 +00:00
system to quickly find available layers, packages, and more.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Fix grammar to be more consistent and discoverable
2015-11-12 11:48:19 +00:00
** Consistent
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
Similar functionalities have the same key binding everywhere, thanks to a
Doc: rewrite core pillars to be straight to the point
2016-01-03 17:57:34 +00:00
clearly defined set of conventions. Documentation is mandatory for any layer
that ships with Spacemacs.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
** Crowd-Configured
Doc: rewrite core pillars to be straight to the point
2016-01-03 17:57:34 +00:00
Community-driven configuration provides curated packages tuned by power users
and bugs are fixed quickly.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
typo
2017-04-24 07:30:50 +00:00
* Highlighted features
doc: rewrite of goals as highlighted feature
2016-01-03 18:07:18 +00:00
- *Bring the efficiency of modal editing* to the powerful Emacs lisp platform.
Modal UX is optional and Spacemacs can be used with only Emacs key bindings.
- Integrate nicely with =Evil= states (=Vim= modes).
- *Keep your fingers on the home row* for quicker editing with support for
QWERTY and BEPO layouts.
Add small, non-structural fixes to documentation
2016-04-23 06:33:55 +00:00
- *Minimalistic and nice graphical UI* keeps your available screen space for
doc: rewrite of goals as highlighted feature
2016-01-03 18:07:18 +00:00
what matters: your text files.
Add small, non-structural fixes to documentation
2016-04-23 06:33:55 +00:00
- *Fast boot time*: packages and configuration are lazy-loaded as much as
Update documentation and parameters for the portable dumper
2019-07-26 19:35:23 +00:00
possible. For even faster boot time, Spacemacs now provides full support for
the new portable dumper available in Emacs 27 and later.
doc: rewrite of goals as highlighted feature
2016-01-03 18:07:18 +00:00
- *Lower the risk of RSI* by heavily using the space bar instead of modifiers.
If you have issues with your thumbs you can still use Spacemacs using
modifiers.
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
- Contribute easily with your improvements and new configuration layers.
doc: rewrite of goals as highlighted feature
2016-01-03 18:07:18 +00:00
- *Very active and helpful community* on =Gitter= and =IRC=
(via Gitter IRC bridge)
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
* Screenshots
space-doc: disable line numbers and resized images Resize images to 600 pixel width (exclude README.org for now) Disable line numbers.
2016-06-10 19:50:45 +00:00
[[file:img/spacemacs-python.png]]
/Python/
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
doc: Be consistent with ref to Spacemacs Use of =Spacemacs= vs Spacemacs is inconsistent. This picks Spacemacs as a convention
2015-10-12 23:12:09 +00:00
*Note*: Even though screenshots are updated frequently, Spacemacs is evolving
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
quickly and the screenshots may not reflect exactly the current state of the
Markup fixes This makes all Notes in DOCUMENTATION.org be *Note*: and changes the markup around the spacemacs init file path in jabbers README.org to proper org markup.
2015-10-13 11:41:48 +00:00
project.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
* Who can benefit from this?
doc: rewrite of Who can benefit from this
2016-01-03 18:18:55 +00:00
- Spacemacs was initially intended to be used by *Vim users* who want to go to
Update README.org template Replace some local Org links with GitHub ones
2017-07-16 16:37:37 +00:00
the next level by using Emacs (see [[https://github.com/syl20bnr/spacemacs/blob/master/doc/VIMUSERS.org][guide]] for Vimmers). But it is now
doc: rewrite of Who can benefit from this
2016-01-03 18:18:55 +00:00
perfectly *usable by non Vim users* by choosing the =emacs= editing style.
Change HTTP to HTTPS in docs
2017-05-16 12:18:50 +00:00
- It is also a good fit for people wanting to *lower the [[https://en.wikipedia.org/wiki/Repetitive_strain_injury][risk of RSI]]* induced by
Add small, non-structural fixes to documentation
2016-04-23 06:33:55 +00:00
the default Emacs key bindings. (This is an assumption, there are no official
studies to prove this!) If you have issues using your thumbs you can still
doc: rewrite of Who can benefit from this
2016-01-03 18:18:55 +00:00
use the =emacs= editing style which puts the leader key on a modifier
combination.
- Emacs users wanting to learn *a different way to edit files* or wanting to
learn Vim key bindings or even wanting to mix both editing styles by setting
their style to =hybrid=.
- Emacs users wanting a simple but deep configuration system that greatly
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
*lowers the risk of .emacs bankruptcy*.
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
- *Pair-programming* users thanks to out of the box support for dynamic
switching of editing style. A Vim user and an Emacs user can use the same
Spacemacs comfortably.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
* Update and Rollback
** Update Spacemacs repository
spacemacs-buffer: Distinguish types of updates Add a spacemacs update button to the spacemacs buffer, and relabel the package update button to read "Update Packages". This will hopefully resolve some confusion about updating spacemacs vs. updating the packages. I also tweaked the switch-to-version function to make it a little more verbose to use it for the spacemacs update button.
2015-10-12 21:00:59 +00:00
There are several methods of updating the core files and layer information for
Add small, non-structural fixes to documentation
2016-04-23 06:33:55 +00:00
Spacemacs. It is recommended to update the packages first; see the next section.
spacemacs-buffer: Distinguish types of updates Add a spacemacs update button to the spacemacs buffer, and relabel the package update button to read "Update Packages". This will hopefully resolve some confusion about updating spacemacs vs. updating the packages. I also tweaked the switch-to-version function to make it a little more verbose to use it for the spacemacs update button.
2015-10-12 21:00:59 +00:00
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
*** Automatic Updates
Mention the change of dotspacemacs-check-for-update in the documentation Its default value was changed to nil in 9d72b122459a45edc81511522f72c7ba58488e50.
2017-05-17 01:46:34 +00:00
Spacemacs will automatically check for a new version periodically. When it
Fix a minor grammatical mistake
2016-06-10 20:13:44 +00:00
detects that a new version is available an arrow will appear in the modeline.
Update documentation for updating. Add screenshot of update arrow. Also add a little for "who is this for" section.
2015-09-05 07:51:32 +00:00
Click it to update Spacemacs. You must restart Emacs after updating.
[[file:img/powerline-update.png]]
space-doc: disable line numbers and resized images Resize images to 600 pixel width (exclude README.org for now) Disable line numbers.
2016-06-10 19:50:45 +00:00
/Update Button/
Update documentation for updating. Add screenshot of update arrow. Also add a little for "who is this for" section.
2015-09-05 07:51:32 +00:00
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
*Note*: If you use the =develop= branch of Spacemacs, automatic update is
Add small, non-structural fixes to documentation
2016-04-23 06:33:55 +00:00
disabled---you have to update manually using git.
spacemacs-buffer: Distinguish types of updates Add a spacemacs update button to the spacemacs buffer, and relabel the package update button to read "Update Packages". This will hopefully resolve some confusion about updating spacemacs vs. updating the packages. I also tweaked the switch-to-version function to make it a little more verbose to use it for the spacemacs update button.
2015-10-12 21:00:59 +00:00
*** Updating from the Spacemacs Buffer
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
Use the button labeled "Update Spacemacs" in the Spacemacs buffer. You will be
Make NeoTree more "vim" friendly This rebinds keys in NeoTree so that `g` and `G` work correctly
2015-10-27 13:51:54 +00:00
prompted for the version you would like to use.
spacemacs-buffer: Distinguish types of updates Add a spacemacs update button to the spacemacs buffer, and relabel the package update button to read "Update Packages". This will hopefully resolve some confusion about updating spacemacs vs. updating the packages. I also tweaked the switch-to-version function to make it a little more verbose to use it for the spacemacs update button.
2015-10-12 21:00:59 +00:00
*Note*: If you use the =develop= branch of Spacemacs, you cannot use this method.
*** Updating Manually with git
Update documentation for updating. Add screenshot of update arrow. Also add a little for "who is this for" section.
2015-09-05 07:51:32 +00:00
To update manually close Emacs and update the git repository:
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+BEGIN_SRC sh
Reformat documentation
2018-09-19 03:54:47 +00:00
$ git pull origin master
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
*Note*: The master branch is considered to be immutable in the sense that you
must not modify it by adding your own commit. If you do so you will break the
automatic update of Spacemacs on the master branch. To fork Spacemacs code you
have to use a custom branch that you manage manually.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
** Update packages
spacemacs-buffer: Distinguish types of updates Add a spacemacs update button to the spacemacs buffer, and relabel the package update button to read "Update Packages". This will hopefully resolve some confusion about updating spacemacs vs. updating the packages. I also tweaked the switch-to-version function to make it a little more verbose to use it for the spacemacs update button.
2015-10-12 21:00:59 +00:00
To update the Emacs packages used by Spacemacs press RET (enter) or click on the
docs: Note commands for update/rollback packages In case someone doesn't want to use the buttons
2015-11-09 15:33:01 +00:00
link =[Update Packages]= in the startup page under the banner then restart
Emacs. If you prefer, you can use the command
=configuration-layer/update-packages= instead of the button.
If anything goes wrong you should be able to rollback the update by pressing
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
~RET~ or clicking on the =[Rollback Package Update]= link in the startup page
Add small, non-structural fixes to documentation
2016-04-23 06:33:55 +00:00
and choosing a rollback slot (sorted by date). This button uses the command
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
=configuration-layer/rollback=.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
* Configuration layers
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
This section is an overview of layers. A more extensive introduction to writing
Update README.org template Replace some local Org links with GitHub ones
2017-07-16 16:37:37 +00:00
configuration layers can be found [[https://github.com/syl20bnr/spacemacs/blob/master/doc/LAYERS.org][here]] (recommended reading!).
Update layer information in DOCUMENTATION.org.
2015-09-05 07:49:47 +00:00
** Purpose
Layers help collect related packages together to provide features. For example,
Add small, non-structural fixes to documentation
2016-04-23 06:33:55 +00:00
the =python= layer provides auto-completion, syntax checking, and REPL support
Update layer information in DOCUMENTATION.org.
2015-09-05 07:49:47 +00:00
for python files. This approach helps keep configuration organized and reduces
overhead for the user by keeping them from having to think about what packages
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
to install. To install all the =python= features the user has just to add the
=python= layer to their dotfile.
Add doc on how to write layers [ci skip]
2015-08-05 20:09:58 +00:00
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
** Structure
Configuration is organized in layers. Each layer has the following structure:
#+BEGIN_EXAMPLE
Reformat documentation
2018-09-19 03:54:47 +00:00
[layer_name]
|__ [local]
| |__ [package 1]
| | ...
| |__ [package n]
|-- layers.el
|__ packages.el
|__ funcs.el
|__ config.el
|__ keybindings.el
[] = directory
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
#+END_EXAMPLE
Where:
core: new layer file -> layers.el / Fix regressions of previous commits The new layer file `layers.el` is used to declared additional layers. It is like the sibling of packages.el except that for now it does not take a list (can do this in a futur commit). The new order for file loading is the following: layers.el > packages.el > funcs.el > config.el > keybindings.el Since packages.el relies on some undefined stuff encapsulated in init functions, it is not meant to be byte compiled. OTOH funcs.el (where lies most of the computation added by a package config) should be compilable. Since we load packages.el very early it is not possible to use `configuration-layer/package-usedp` in funcs.el. This commit also fixes the tests.
2016-05-29 01:20:23 +00:00
| File | Usage |
|----------------+--------------------------------------------------------------------------------------------------|
| layers.el | The place to declare additional layers |
| packages.el | The list of packages and their configuration functions (init, post-init, etc...) |
| funcs.el | All functions defined in the layer (used in package configuration for instance) |
| config.el | Layer configuration (defines the layer variables default values and setup some config variables) |
Minor typo fix Change "no tied to" to "not tied to" for the `keybindings.el` file description.
2017-01-16 14:19:03 +00:00
| keybindings.el | General key bindings not tied to a specific package configuration |
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
=Packages= can be:
- =ELPA= packages installed from an =ELPA= compliant repository
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
- local packages in a layer's =local= folder
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
- installed from an online source using [[https://github.com/quelpa/quelpa][quelpa]].
** Configure packages
*** With a layer
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
**** Declaration
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
=Packages= are declared in a variable called =<layer>-packages= where =<layer>=
is the name of the layer.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Example:
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(setq <layer>-packages '(package1 package2 ...)
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
All packages from all layers are processed in alphabetical order so sometimes
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
you'll have to use some =with-eval-after-load= black magic to configure them
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
properly. For instance, if package =A= depends on =B= then you can configure
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
=A= with:
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(with-eval-after-load 'B ...)
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
#+END_SRC
Update README.org template Replace some local Org links with GitHub ones
2017-07-16 16:37:37 +00:00
For details on installing packages using quelpa or local packages see [[https://github.com/syl20bnr/spacemacs/blob/master/doc/LAYERS.org#packagesel][LAYERS]].
Update layer information in DOCUMENTATION.org.
2015-09-05 07:49:47 +00:00
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
**** Initialization
Remove some mentions of extensions
2016-04-11 12:53:13 +00:00
To initialize a package =xxx=, define a function with this format in
=packages.el=:
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(defun <layer>/init-xxx () ...body )
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
It is common to define the body with the [[https://github.com/jwiegley/use-package][use-package]] macro.
**** Exclusion
Add small, non-structural fixes to documentation
2016-04-23 06:33:55 +00:00
It is possible to exclude some packages from Spacemacs on a per-layer basis.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
This is useful when a configuration layer aims to replace a stock package
doc: Be consistent with ref to Spacemacs Use of =Spacemacs= vs Spacemacs is inconsistent. This picks Spacemacs as a convention
2015-10-12 23:12:09 +00:00
declared in the Spacemacs layer.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
To do so add the package names to exclude to the variable
=<layer>-excluded-packages=.
Example:
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(setq <layer>-excluded-packages '(package1 package2 ...)
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Add to docs, replacing a layer package with a local version When contributing to packages it is often handy to replace a package, already installed and configured by some layer with a local version of the package (i.e. a git repo). This commit adds instructions for how to achieve that.
2021-03-16 21:31:39 +00:00
**** Overriding a layer package
[doc] Fix broken link (#14828)
2021-06-05 16:28:48 +00:00
See [[https://develop.spacemacs.org/doc/FAQ.html#how-to-override-a-layer-package][this answer in the FAQ's]].
documentation formatting: Sat Mar 20 21:07:12 UTC 2021
2021-03-20 21:07:12 +00:00
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
*** Without a layer
Sometimes a layer can be an unnecessary overhead, this is the case if you just
Fix some typos (#14832)
2021-06-06 23:43:22 +00:00
want to install a package with very few configurations associated to it. A good
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
example is some niche language where you are only interested in syntax
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
highlighting.
You can install such packages by adding them to the variable
Correct docs on loading of packages without layer This commit clarifies where to find the =dotspacemacs-additional-packages= variable. It also improves upon the code example.
2016-06-18 05:05:41 +00:00
=dotspacemacs-additional-packages= under the =dotspacemacs/layers= function in your dotfile.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Correct docs on loading of packages without layer This commit clarifies where to find the =dotspacemacs-additional-packages= variable. It also improves upon the code example.
2016-06-18 05:05:41 +00:00
For example, to install =llvm-mode= and =dts-mode=:
Reformat docs
2018-07-10 10:57:25 +00:00
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(defun dotspacemacs/layers ()
"Configuration Layers declaration..."
(setq-default
;; ...
dotspacemacs-additional-packages '(llvm-mode dts-mode)
;; ...
))
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
If you want to add some configuration for them, do so in the
=dotspacemacs/user-config= function, or consider creating a layer.
Correct docs on loading of packages without layer This commit clarifies where to find the =dotspacemacs-additional-packages= variable. It also improves upon the code example.
2016-06-18 05:05:41 +00:00
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
** Packages synchronization
Spacemacs will only install the packages that are explicitly used by the user.
A package is considered to be used if its layer is used (i.e. listed in
=dotspacemacs-configuration-layers=).
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
Any package that is not used will be considered an orphan and will be deleted at
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
the next startup of Emacs.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
** Types of configuration layers
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
There are two types of configuration layers:
Reformat documentation
2018-09-19 03:54:47 +00:00
- distributed layers (in the =layers= directory, those layers are contributions shared
by the community and merged upstream)
- private (in the =private= directory, they are ignored by Git)
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
** Submitting a configuration layer upstream
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
If you decide to provide a configuration layer, please check the contribution
Convert new exporter into standalone tool
2017-07-29 07:41:05 +00:00
guidelines first in [[https://github.com/syl20bnr/spacemacs/blob/develop/COMMUNITY.org][CONTRIBUTING]].
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
** Example: Themes Megapack example
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
This is a simple configuration layer listing a bunch of themes which you can
Convert new exporter into standalone tool
2017-07-29 07:41:05 +00:00
find [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Bthemes/themes-megapack/README.org][here]].
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
To install it, just add =themes-megapack= to your =~/.spacemacs= like so:
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(setq-default dotspacemacs-configuration-layers '(themes-megapack))
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Add small, non-structural fixes to documentation
2016-04-23 06:33:55 +00:00
Adding this layer will install around 100 themes; to uninstall them remove the
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
layer from the =dotspacemacs-configuration-layers= and press ~SPC f e R~.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
** Managing private configuration layers
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
Spacemacs's configuration system is flexible enough to let you manage your
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
private layers in different ways.
*** Using the private directory
Everything in the private directory is ignored by Git so it is a good place to
store private layers. There is a huge drawback to this approach though: /your
layers are not source controlled/.
*** Using an external Git repository
This is the recommended way to manage your private layers.
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
The best approach is to store all your private layers in an external Git
Update guidance on using external Git repository Changed the wording to something that flows better.
2017-12-20 01:23:56 +00:00
repository. For example, if you have a =dotfiles= repository it is a good
practice to store these layers in there, along with your =~/.spacemacs= file.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
Then you are free to symlink your layers into =~/emacs.d/private= /or/ leave them
anywhere you want, and reference the parent directory in the variable
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
=dotspacemacs-configuration-layer-path= of your =~/.spacemacs=.
Fix capitalization of changes Update capitalization as per feedback.
2017-12-20 00:14:29 +00:00
*Note*: You could also have a dedicated repository for all your private layers
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
and then directly clone this repository in =~/.emacs.d/private=.
*** Using a personal branch
The final main way to manage your private layers is to push them in a personal
branch that you keep up to date with upstream =master= or =develop=.
Add doc on how to write layers [ci skip]
2015-08-05 20:09:58 +00:00
** Tips for writing layers
Convert new exporter into standalone tool
2017-07-29 07:41:05 +00:00
Please refer to [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/LAYERS.org][this]] introduction for some tips on writing layers, and how to
Add doc on how to write layers [ci skip]
2015-08-05 20:09:58 +00:00
best make them fit with the Spacemacs philosophy and loading strategy.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
* Dotfile Configuration
User configuration can be stored in your =~/.spacemacs= file.
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
** Dotfile Installation
The very first time Spacemacs starts up, it will ask you several questions
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
and then install the =.spacemacs= file in your =HOME= directory.
Mention .spacemacs.d in documentation
2015-08-26 12:36:49 +00:00
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
** Alternative dotdirectory
A dotdirectory =~/.spacemacs.d/= can be used instead of a dotfile.
If you want to use this option, move =~/.spacemacs= to =~/.spacemacs.d/init.el=.
Mention .spacemacs.d in documentation
2015-08-26 12:36:49 +00:00
It is also possible to override the location of =~/.spacemacs.d/= using the
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
environment variable =SPACEMACSDIR=. Of course, you can also use symlinks to
Mention .spacemacs.d in documentation
2015-08-26 12:36:49 +00:00
change the location of this directory.
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
*Note*: =~/.spacemacs= will always take priority over =~/.spacemacs.d/init.el=,
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
so =~/.spacemacs= must not exist for =~/.spacemacs.d/init.el= to be used by
Spacemacs.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
** Synchronization of dotfile changes
To apply the modifications made in =~/.spacemacs= press ~SPC f e R~. It will
doc: Be consistent with ref to Spacemacs Use of =Spacemacs= vs Spacemacs is inconsistent. This picks Spacemacs as a convention
2015-10-12 23:12:09 +00:00
re-execute the Spacemacs initialization process.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
*Note*: A synchronization re-executes the functions =dotspacemacs/init=,
=dotspacemacs/user-init= and =dotspacemacs/user-config=.
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
Depending on the contents of these functions, you may encounter some unwanted side
effects. For instance, if you use a toggle in =dotspacemac/user-config= to enable
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
some behavior, this behavior will be turned off whenever the dotfile is
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
re-synchronized. To avoid these side-effects, it is recommended to either use
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
=setq= expressions instead of toggle functions, or to use the =on= or =off=
versions instead (i.e. instead of =spacemacs/toggle-<thing>=, use
=spacemacs/toggle-<thing>-on= or =spacemacs/toggle-<thing>-off=).
It is possible to /skip/ the execution of =dotspacemacs/user-config= with the
universal argument (~SPC u SPC f e R~).
** Testing the dotfile
[doc] Fix some additional `SPC :` to `SPC SPC`
2016-02-07 13:39:54 +00:00
You can use the command =SPC SPC dotspacemacs/test-dotfile= to check if your
Document dotspacemacs/test-dotfile Fix #3181 [ci-skip]
2015-09-30 08:58:10 +00:00
=~/.spacemacs= looks correct. This will check, among other things, whether the
declared layers can be found and that the variables have sensible values. These
tests are also run automatically when you synchronize with ~SPC f e R~.
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
** Dotfile Contents
core: reimplement :packages keyword and update documentation Old implementation excluded package that were not selected, this implementation does not excluded them, it simply ignore it in the layer where they are not selected. This reimplementation comes from a refactor of the way packages.el files are loaded, instead of loading these files at the moment of resolving the list of used packages, they are now loaded when making the layer objects. A neat consequence is that side effects is better confined and the configuration-layer/get-packages is now pure (at least a lot more pure than before). In the `cfgl-layer` class the slot `:user-packages` has been renamed to `:selected-packages` which defaults to `'all` meaning that all the packages in `:packages` are selected. `:selected-packages` value is given by the new function `configuration-layer//select-packages`. Effectively selected packages are given by a new method for `cfgl-layer` class called `cfgl-layer-get-packages`. Tests have been updated to reflect the changes. Also documentation on configuration layer declaration in the dotfile section of DOCUMENTATION.org has been greatly improved (I hope) and reflect the last feature added to the `dotspacemacs-configuration-layers` list.
2016-06-21 00:48:25 +00:00
*** Configuration functions
Correct minor errors in DOCUMENTATION.org
2016-12-18 20:34:56 +00:00
Five special functions in the =~/.spacemacs= file can be used to perform
core: reimplement :packages keyword and update documentation Old implementation excluded package that were not selected, this implementation does not excluded them, it simply ignore it in the layer where they are not selected. This reimplementation comes from a refactor of the way packages.el files are loaded, instead of loading these files at the moment of resolving the list of used packages, they are now loaded when making the layer objects. A neat consequence is that side effects is better confined and the configuration-layer/get-packages is now pure (at least a lot more pure than before). In the `cfgl-layer` class the slot `:user-packages` has been renamed to `:selected-packages` which defaults to `'all` meaning that all the packages in `:packages` are selected. `:selected-packages` value is given by the new function `configuration-layer//select-packages`. Effectively selected packages are given by a new method for `cfgl-layer` class called `cfgl-layer-get-packages`. Tests have been updated to reflect the changes. Also documentation on configuration layer declaration in the dotfile section of DOCUMENTATION.org has been greatly improved (I hope) and reflect the last feature added to the `dotspacemacs-configuration-layers` list.
2016-06-21 00:48:25 +00:00
configuration at the beginning and end of Spacemacs loading process:
- =dotspacemacs/init= is called at the very startup of Spacemacs initialization
before layers configuration. *You should not put any user code* in there
besides modifying the Spacemacs variable values prefixed with =dotspacemacs-=.
- =dotspacemacs/user-init= is called immediately after =dotspacemacs/init=,
before layer configuration. This function is mostly useful for variables
that need to be set before packages are loaded.
core: update environment variables management * add new dotfile function `dotspacemacs/user-env` * add ignored env. vars with variable spacemacs-ignored-environment-variables * ignore env vars: SSH_AUTH_SOCK and DBUS_SESSION_BUS_ADDRESS * update documentation in DOCUMENTATION.org * update .spacemacs.template with new function * rename environment file from spacemacs.env to .spacemacs.env * move location of .spacemacs.env file to home or dotdirectory * add a header to the generated .spacemacs.env file to explain what it is * make SPC f e e fallbacks to the function dotspacemacs/user-env if the user manages the env var by themselves * make SPC f e E call the new function dotspacemacs/user-env * sort environment variables in .spacemacs.env file
2018-07-03 05:20:06 +00:00
- =dotspacemacs/user-env= is called before the layers and packages configuration
and it is responsible to setup environment variables.
[docs] Fix spelling, Reorder configuration functions To logical order
2018-10-14 21:48:17 +00:00
- =dotspacemacs/layers= is called at the startup of Spacemacs initialization,
this is where you set the Spacemacs distribution and declare layers to be used
in your configuration. You can also add or exclude packages of your choice
and tweak some behaviors of Spacemacs loading.
core: reimplement :packages keyword and update documentation Old implementation excluded package that were not selected, this implementation does not excluded them, it simply ignore it in the layer where they are not selected. This reimplementation comes from a refactor of the way packages.el files are loaded, instead of loading these files at the moment of resolving the list of used packages, they are now loaded when making the layer objects. A neat consequence is that side effects is better confined and the configuration-layer/get-packages is now pure (at least a lot more pure than before). In the `cfgl-layer` class the slot `:user-packages` has been renamed to `:selected-packages` which defaults to `'all` meaning that all the packages in `:packages` are selected. `:selected-packages` value is given by the new function `configuration-layer//select-packages`. Effectively selected packages are given by a new method for `cfgl-layer` class called `cfgl-layer-get-packages`. Tests have been updated to reflect the changes. Also documentation on configuration layer declaration in the dotfile section of DOCUMENTATION.org has been greatly improved (I hope) and reflect the last feature added to the `dotspacemacs-configuration-layers` list.
2016-06-21 00:48:25 +00:00
- =dotspacemacs/user-config= is called at the very end of Spacemacs
initialization after layers configuration. This is the place where most of
your configurations should be done. Unless it is explicitly specified that a
variable should be set before a package is loaded, you should place your code
here.
core: allow users to set custom-file variable In this case Spacemacs won't write custom variables to the dotspacemacs/emacs-custom-settings variable. Move setq and add-advice to spacemacs/initialize-custom-file which is now called in spacemacs/init function just after dotspacemacs/user-init function.
2017-02-20 03:51:58 +00:00
- =dotspacemacs/emacs-custom-settings= is a generated function where all Emacs
custom settings are written. You should not edit this function. See
=Custom variables= section for more information.
core: reimplement :packages keyword and update documentation Old implementation excluded package that were not selected, this implementation does not excluded them, it simply ignore it in the layer where they are not selected. This reimplementation comes from a refactor of the way packages.el files are loaded, instead of loading these files at the moment of resolving the list of used packages, they are now loaded when making the layer objects. A neat consequence is that side effects is better confined and the configuration-layer/get-packages is now pure (at least a lot more pure than before). In the `cfgl-layer` class the slot `:user-packages` has been renamed to `:selected-packages` which defaults to `'all` meaning that all the packages in `:packages` are selected. `:selected-packages` value is given by the new function `configuration-layer//select-packages`. Effectively selected packages are given by a new method for `cfgl-layer` class called `cfgl-layer-get-packages`. Tests have been updated to reflect the changes. Also documentation on configuration layer declaration in the dotfile section of DOCUMENTATION.org has been greatly improved (I hope) and reflect the last feature added to the `dotspacemacs-configuration-layers` list.
2016-06-21 00:48:25 +00:00
*** Custom variables
core: allow users to set custom-file variable In this case Spacemacs won't write custom variables to the dotspacemacs/emacs-custom-settings variable. Move setq and add-advice to spacemacs/initialize-custom-file which is now called in spacemacs/init function just after dotspacemacs/user-init function.
2017-02-20 03:51:58 +00:00
By default custom variables from =M-x customize-group= are automatically saved
at the end of your =~/.spacemacs= file in the function
Documentation fixes. Fixes: - Typo - Code block indentation - Put keybindings on one line so they look nicer when viewed in Spacemacs - Make one sentence sound better
2017-04-18 06:05:28 +00:00
=dotspacemacs/emacs-custom-settings= unless you declare a custom =custom-file=
core: allow users to set custom-file variable In this case Spacemacs won't write custom variables to the dotspacemacs/emacs-custom-settings variable. Move setq and add-advice to spacemacs/initialize-custom-file which is now called in spacemacs/init function just after dotspacemacs/user-init function.
2017-02-20 03:51:58 +00:00
in the =dotspacemacs/user-init= function, in this case custom variables will be
written to the user defined =custom-file= and the function
=dotspacemacs/emacs-custom-settings= will remain empty.
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
*Note*: If you set a custom =custom-file= value then it is your responsibility
core: allow users to set custom-file variable In this case Spacemacs won't write custom variables to the dotspacemacs/emacs-custom-settings variable. Move setq and add-advice to spacemacs/initialize-custom-file which is now called in spacemacs/init function just after dotspacemacs/user-init function.
2017-02-20 03:51:58 +00:00
to load this file at the appropriate time. Often the best time to load it is
just after setting the value for =custom-file= in the =dotspacemacs/user-init=
function.
core: reimplement :packages keyword and update documentation Old implementation excluded package that were not selected, this implementation does not excluded them, it simply ignore it in the layer where they are not selected. This reimplementation comes from a refactor of the way packages.el files are loaded, instead of loading these files at the moment of resolving the list of used packages, they are now loaded when making the layer objects. A neat consequence is that side effects is better confined and the configuration-layer/get-packages is now pure (at least a lot more pure than before). In the `cfgl-layer` class the slot `:user-packages` has been renamed to `:selected-packages` which defaults to `'all` meaning that all the packages in `:packages` are selected. `:selected-packages` value is given by the new function `configuration-layer//select-packages`. Effectively selected packages are given by a new method for `cfgl-layer` class called `cfgl-layer-get-packages`. Tests have been updated to reflect the changes. Also documentation on configuration layer declaration in the dotfile section of DOCUMENTATION.org has been greatly improved (I hope) and reflect the last feature added to the `dotspacemacs-configuration-layers` list.
2016-06-21 00:48:25 +00:00
** Declaring Configuration layers
To use a configuration layer, declare it in your dotfile by adding it to the
=dotspacemacs-configuration-layers= variable of your =~/.spacemacs=.
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
*Note*: In this documentation a =used layer= is equivalent to a =declared
core: reimplement :packages keyword and update documentation Old implementation excluded package that were not selected, this implementation does not excluded them, it simply ignore it in the layer where they are not selected. This reimplementation comes from a refactor of the way packages.el files are loaded, instead of loading these files at the moment of resolving the list of used packages, they are now loaded when making the layer objects. A neat consequence is that side effects is better confined and the configuration-layer/get-packages is now pure (at least a lot more pure than before). In the `cfgl-layer` class the slot `:user-packages` has been renamed to `:selected-packages` which defaults to `'all` meaning that all the packages in `:packages` are selected. `:selected-packages` value is given by the new function `configuration-layer//select-packages`. Effectively selected packages are given by a new method for `cfgl-layer` class called `cfgl-layer-get-packages`. Tests have been updated to reflect the changes. Also documentation on configuration layer declaration in the dotfile section of DOCUMENTATION.org has been greatly improved (I hope) and reflect the last feature added to the `dotspacemacs-configuration-layers` list.
2016-06-21 00:48:25 +00:00
layer=.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Update README.org template Replace some local Org links with GitHub ones
2017-07-16 16:37:37 +00:00
For instance, [[#thank-you][RMS]] can add his private configuration layer like this:
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+BEGIN_SRC emacs-lisp
Documentation fixes. Fixes: - Typo - Code block indentation - Put keybindings on one line so they look nicer when viewed in Spacemacs - Make one sentence sound better
2017-04-18 06:05:28 +00:00
(setq-default dotspacemacs-configuration-layers
'(
;; other layers
;; rms layer added at the end of the list
rms
))
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
core: reimplement :packages keyword and update documentation Old implementation excluded package that were not selected, this implementation does not excluded them, it simply ignore it in the layer where they are not selected. This reimplementation comes from a refactor of the way packages.el files are loaded, instead of loading these files at the moment of resolving the list of used packages, they are now loaded when making the layer objects. A neat consequence is that side effects is better confined and the configuration-layer/get-packages is now pure (at least a lot more pure than before). In the `cfgl-layer` class the slot `:user-packages` has been renamed to `:selected-packages` which defaults to `'all` meaning that all the packages in `:packages` are selected. `:selected-packages` value is given by the new function `configuration-layer//select-packages`. Effectively selected packages are given by a new method for `cfgl-layer` class called `cfgl-layer-get-packages`. Tests have been updated to reflect the changes. Also documentation on configuration layer declaration in the dotfile section of DOCUMENTATION.org has been greatly improved (I hope) and reflect the last feature added to the `dotspacemacs-configuration-layers` list.
2016-06-21 00:48:25 +00:00
Official layers shipped with Spacemacs are stored in =~/.emacs.d/layers=. The
directory =~/.emacs.d/private= is a drop-in location for your private layers.
It is possible to put layers at the location of your choice provided you tell
Spacemacs where to look for them. This is done by setting the list
=dotspacemacs-configuration-layer-path= in your =~/.spacemacs=. For instance
to add some layers in =~/.myconfig=, set the variable like this:
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(setq-default dotspacemacs-configuration-layer-path '("~/.myconfig/"))
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
*** Setting configuration layers variables
Some configuration layers have configuration variables to enable specific
Convert new exporter into standalone tool
2017-07-29 07:41:05 +00:00
features. For instance the [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Bsource-control/git/README.org][git layer]] has several configuration variables, they
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
can be set directly in the =dotspacemacs-configuration-layers= like this:
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(defun dotspacemacs/layers ()
;; List of configuration layers to load.
(setq-default dotspacemacs-configuration-layers
'(auto-completion
(git :variables
git-magit-status-fullscreen t
git-variable-example nil)
smex)))
core: reimplement :packages keyword and update documentation Old implementation excluded package that were not selected, this implementation does not excluded them, it simply ignore it in the layer where they are not selected. This reimplementation comes from a refactor of the way packages.el files are loaded, instead of loading these files at the moment of resolving the list of used packages, they are now loaded when making the layer objects. A neat consequence is that side effects is better confined and the configuration-layer/get-packages is now pure (at least a lot more pure than before). In the `cfgl-layer` class the slot `:user-packages` has been renamed to `:selected-packages` which defaults to `'all` meaning that all the packages in `:packages` are selected. `:selected-packages` value is given by the new function `configuration-layer//select-packages`. Effectively selected packages are given by a new method for `cfgl-layer` class called `cfgl-layer-get-packages`. Tests have been updated to reflect the changes. Also documentation on configuration layer declaration in the dotfile section of DOCUMENTATION.org has been greatly improved (I hope) and reflect the last feature added to the `dotspacemacs-configuration-layers` list.
2016-06-21 00:48:25 +00:00
#+END_SRC
The =:variables= keyword is a convenience to keep layer configuration close to
their declaration. Setting layer variables in the =dotspacemacs/user-init=
function of your dotfile is also a perfectly valid way to configure a layer.
*** Disabling layer services in other layers
Often layers enable services that other layers can use. For instance if you use
Correct minor errors in DOCUMENTATION.org
2016-12-18 20:34:56 +00:00
the layer =auto-completion= then all other layers supporting =auto-completion=
core: reimplement :packages keyword and update documentation Old implementation excluded package that were not selected, this implementation does not excluded them, it simply ignore it in the layer where they are not selected. This reimplementation comes from a refactor of the way packages.el files are loaded, instead of loading these files at the moment of resolving the list of used packages, they are now loaded when making the layer objects. A neat consequence is that side effects is better confined and the configuration-layer/get-packages is now pure (at least a lot more pure than before). In the `cfgl-layer` class the slot `:user-packages` has been renamed to `:selected-packages` which defaults to `'all` meaning that all the packages in `:packages` are selected. `:selected-packages` value is given by the new function `configuration-layer//select-packages`. Effectively selected packages are given by a new method for `cfgl-layer` class called `cfgl-layer-get-packages`. Tests have been updated to reflect the changes. Also documentation on configuration layer declaration in the dotfile section of DOCUMENTATION.org has been greatly improved (I hope) and reflect the last feature added to the `dotspacemacs-configuration-layers` list.
2016-06-21 00:48:25 +00:00
will have this feature enabled.
Sometimes you may want to disable a service added by a layer in some specific
layers. Say you want to disable =auto-completion= in =org= and =git= layers,
you can do it with the following layer declaration.
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(defun dotspacemacs/layers ()
;; List of configuration layers to load.
(setq-default dotspacemacs-configuration-layers
'(org git
(auto-completion :disabled-for org git))))
core: reimplement :packages keyword and update documentation Old implementation excluded package that were not selected, this implementation does not excluded them, it simply ignore it in the layer where they are not selected. This reimplementation comes from a refactor of the way packages.el files are loaded, instead of loading these files at the moment of resolving the list of used packages, they are now loaded when making the layer objects. A neat consequence is that side effects is better confined and the configuration-layer/get-packages is now pure (at least a lot more pure than before). In the `cfgl-layer` class the slot `:user-packages` has been renamed to `:selected-packages` which defaults to `'all` meaning that all the packages in `:packages` are selected. `:selected-packages` value is given by the new function `configuration-layer//select-packages`. Effectively selected packages are given by a new method for `cfgl-layer` class called `cfgl-layer-get-packages`. Tests have been updated to reflect the changes. Also documentation on configuration layer declaration in the dotfile section of DOCUMENTATION.org has been greatly improved (I hope) and reflect the last feature added to the `dotspacemacs-configuration-layers` list.
2016-06-21 00:48:25 +00:00
#+END_SRC
Implement :enabled-for layer keyword
2016-08-30 09:26:38 +00:00
You can also use the =:enabled-for= construct to disable it for /all/ layers
/except/ those explicitly identified.
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(defun dotspacemacs/layers ()
;; List of configuration layers to load.
(setq-default dotspacemacs-configuration-layers
'(java python c-c++
(auto-completion :enabled-for java python))))
Implement :enabled-for layer keyword
2016-08-30 09:26:38 +00:00
#+END_SRC
Note that =:enabled-for= may be an empty list.
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(defun dotspacemacs/layers ()
;; List of configuration layers to load.
(setq-default dotspacemacs-configuration-layers
'(java python c-c++
(auto-completion :enabled-for))))
Implement :enabled-for layer keyword
2016-08-30 09:26:38 +00:00
#+END_SRC
=:enabled-for= takes precedence over =:disabled-for= if both are present.
core: reimplement :packages keyword and update documentation Old implementation excluded package that were not selected, this implementation does not excluded them, it simply ignore it in the layer where they are not selected. This reimplementation comes from a refactor of the way packages.el files are loaded, instead of loading these files at the moment of resolving the list of used packages, they are now loaded when making the layer objects. A neat consequence is that side effects is better confined and the configuration-layer/get-packages is now pure (at least a lot more pure than before). In the `cfgl-layer` class the slot `:user-packages` has been renamed to `:selected-packages` which defaults to `'all` meaning that all the packages in `:packages` are selected. `:selected-packages` value is given by the new function `configuration-layer//select-packages`. Effectively selected packages are given by a new method for `cfgl-layer` class called `cfgl-layer-get-packages`. Tests have been updated to reflect the changes. Also documentation on configuration layer declaration in the dotfile section of DOCUMENTATION.org has been greatly improved (I hope) and reflect the last feature added to the `dotspacemacs-configuration-layers` list.
2016-06-21 00:48:25 +00:00
*** Selecting/Ignoring packages of a layer
By default a declared layer installs/configures all its associated packages. You
may want to select only some of them or ignoring some of them. This is possible
with the =:packages= keyword.
Make treemacs the default file browser.
2019-01-19 15:25:26 +00:00
For instance to ignore the =treemacs= and =fancy-battery= packages from
core: reimplement :packages keyword and update documentation Old implementation excluded package that were not selected, this implementation does not excluded them, it simply ignore it in the layer where they are not selected. This reimplementation comes from a refactor of the way packages.el files are loaded, instead of loading these files at the moment of resolving the list of used packages, they are now loaded when making the layer objects. A neat consequence is that side effects is better confined and the configuration-layer/get-packages is now pure (at least a lot more pure than before). In the `cfgl-layer` class the slot `:user-packages` has been renamed to `:selected-packages` which defaults to `'all` meaning that all the packages in `:packages` are selected. `:selected-packages` value is given by the new function `configuration-layer//select-packages`. Effectively selected packages are given by a new method for `cfgl-layer` class called `cfgl-layer-get-packages`. Tests have been updated to reflect the changes. Also documentation on configuration layer declaration in the dotfile section of DOCUMENTATION.org has been greatly improved (I hope) and reflect the last feature added to the `dotspacemacs-configuration-layers` list.
2016-06-21 00:48:25 +00:00
=spacemacs-ui-visual= layer:
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(defun dotspacemacs/layers ()
;; List of configuration layers to load.
(setq-default dotspacemacs-configuration-layers
'(auto-completion
Make treemacs the default file browser.
2019-01-19 15:25:26 +00:00
(spacemacs-ui-visual :packages (not treemacs fancy-battery))))
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Make treemacs the default file browser.
2019-01-19 15:25:26 +00:00
The opposite would be to ignore all packages except =treemacs= and
core: reimplement :packages keyword and update documentation Old implementation excluded package that were not selected, this implementation does not excluded them, it simply ignore it in the layer where they are not selected. This reimplementation comes from a refactor of the way packages.el files are loaded, instead of loading these files at the moment of resolving the list of used packages, they are now loaded when making the layer objects. A neat consequence is that side effects is better confined and the configuration-layer/get-packages is now pure (at least a lot more pure than before). In the `cfgl-layer` class the slot `:user-packages` has been renamed to `:selected-packages` which defaults to `'all` meaning that all the packages in `:packages` are selected. `:selected-packages` value is given by the new function `configuration-layer//select-packages`. Effectively selected packages are given by a new method for `cfgl-layer` class called `cfgl-layer-get-packages`. Tests have been updated to reflect the changes. Also documentation on configuration layer declaration in the dotfile section of DOCUMENTATION.org has been greatly improved (I hope) and reflect the last feature added to the `dotspacemacs-configuration-layers` list.
2016-06-21 00:48:25 +00:00
=fancy-battery=:
Reimplement #5339 by justbur to add :packages keyword.
2016-06-08 06:16:33 +00:00
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(defun dotspacemacs/layers ()
;; List of configuration layers to load.
(setq-default dotspacemacs-configuration-layers
'(auto-completion
Make treemacs the default file browser.
2019-01-19 15:25:26 +00:00
(spacemacs-ui-visual :packages treemacs fancy-battery)))
Reimplement #5339 by justbur to add :packages keyword.
2016-06-08 06:16:33 +00:00
#+END_SRC
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
*Note*: Ignoring a package from a layer is different than excluding a package.
core: reimplement :packages keyword and update documentation Old implementation excluded package that were not selected, this implementation does not excluded them, it simply ignore it in the layer where they are not selected. This reimplementation comes from a refactor of the way packages.el files are loaded, instead of loading these files at the moment of resolving the list of used packages, they are now loaded when making the layer objects. A neat consequence is that side effects is better confined and the configuration-layer/get-packages is now pure (at least a lot more pure than before). In the `cfgl-layer` class the slot `:user-packages` has been renamed to `:selected-packages` which defaults to `'all` meaning that all the packages in `:packages` are selected. `:selected-packages` value is given by the new function `configuration-layer//select-packages`. Effectively selected packages are given by a new method for `cfgl-layer` class called `cfgl-layer-get-packages`. Tests have been updated to reflect the changes. Also documentation on configuration layer declaration in the dotfile section of DOCUMENTATION.org has been greatly improved (I hope) and reflect the last feature added to the `dotspacemacs-configuration-layers` list.
2016-06-21 00:48:25 +00:00
An excluded packages is completely removed from your configuration whereas an
ignored package is ignored only for a given layer but it can remain on your
system. It happens that if the given layer is the owner of the package then
ignoring this package is the same as excluding it (because the package becomes
orphan so it is considered unused by Spacemacs).
*** Excluding packages
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
You can exclude packages you don't want to install with the variable
Fix export-breaking org links in documentation As discussed in #8054 and #8136, org doesn't always export links correctly if the syntax deviates from the one given on the org mode website. This results in broken links on github and/or spacemacs.org as in #6722, #8036, #8054, #7956 and possibly others. This modifies all links not already fixed in #8136. Internal links are handled with Custom IDs. External file links are formatted according to org guidelines as well (see bottom), and if they point to a specific headline in an external file, a custom ID is created as well. Fixes #6722, #8036, #7956, #7916 as well as other unreported broken links. http://orgmode.org/manual/External-links.html#External-links http://orgmode.org/manual/Internal-links.html#Internal-links TODO: make Custom IDs invisble in space-org-mode
2017-01-09 12:11:54 +00:00
=dotspacemacs-excluded-packages= (see [[#configuration-layers][Configuration layers]] for more info
Deprecation of extensions and <pkg>-excluded-packages variables As announced in previous releases, see CHANGELOG.next for more info in the Breaking Changes section.
2016-01-18 03:06:04 +00:00
on packages).
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Add small, non-structural fixes to documentation
2016-04-23 06:33:55 +00:00
For instance, to disable the =rainbow-delimiters= package:
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(setq-default dotspacemacs-excluded-packages '(rainbow-delimiters))
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
doc: Be consistent with ref to Spacemacs Use of =Spacemacs= vs Spacemacs is inconsistent. This picks Spacemacs as a convention
2015-10-12 23:12:09 +00:00
When you exclude a package, Spacemacs will automatically delete it for you the
core: reimplement :packages keyword and update documentation Old implementation excluded package that were not selected, this implementation does not excluded them, it simply ignore it in the layer where they are not selected. This reimplementation comes from a refactor of the way packages.el files are loaded, instead of loading these files at the moment of resolving the list of used packages, they are now loaded when making the layer objects. A neat consequence is that side effects is better confined and the configuration-layer/get-packages is now pure (at least a lot more pure than before). In the `cfgl-layer` class the slot `:user-packages` has been renamed to `:selected-packages` which defaults to `'all` meaning that all the packages in `:packages` are selected. `:selected-packages` value is given by the new function `configuration-layer//select-packages`. Effectively selected packages are given by a new method for `cfgl-layer` class called `cfgl-layer-get-packages`. Tests have been updated to reflect the changes. Also documentation on configuration layer declaration in the dotfile section of DOCUMENTATION.org has been greatly improved (I hope) and reflect the last feature added to the `dotspacemacs-configuration-layers` list.
2016-06-21 00:48:25 +00:00
next time you launch Emacs or at the next dotfile synchronization. All the
orphan dependencies are also deleted automatically. Excluding a package
effectively remove _all_ references to it in Spacemacs without breaking the rest
of the configuration, this is a powerful feature which allows you to quickly
remove any feature from Spacemacs.
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
*Note*: A few packages are essential for Spacemacs to correctly operate, those
Fix some minor mistakes and typos in the documentation
2016-10-29 12:59:53 +00:00
packages are protected and cannot be excluded or uninstalled even if they become
core: reimplement :packages keyword and update documentation Old implementation excluded package that were not selected, this implementation does not excluded them, it simply ignore it in the layer where they are not selected. This reimplementation comes from a refactor of the way packages.el files are loaded, instead of loading these files at the moment of resolving the list of used packages, they are now loaded when making the layer objects. A neat consequence is that side effects is better confined and the configuration-layer/get-packages is now pure (at least a lot more pure than before). In the `cfgl-layer` class the slot `:user-packages` has been renamed to `:selected-packages` which defaults to `'all` meaning that all the packages in `:packages` are selected. `:selected-packages` value is given by the new function `configuration-layer//select-packages`. Effectively selected packages are given by a new method for `cfgl-layer` class called `cfgl-layer-get-packages`. Tests have been updated to reflect the changes. Also documentation on configuration layer declaration in the dotfile section of DOCUMENTATION.org has been greatly improved (I hope) and reflect the last feature added to the `dotspacemacs-configuration-layers` list.
2016-06-21 00:48:25 +00:00
orphans or are excluded. =use-package= is an example of a protected package that
cannot be removed from Spacemacs.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
* Concepts
doc: update doc on editing styles
2015-09-24 03:08:01 +00:00
** Editing Styles
Add note about ivy/helm choice
2016-08-29 18:58:28 +00:00
Spacemacs comes with several editing styles which can be switched dynamically
doc: update editing style documentation
2016-03-18 00:38:04 +00:00
providing an easier way to do pair programming, for instance between a Vim user
and an Emacs user.
Three styles are available:
- Vim,
- Emacs,
- Hybrid (a mix between Vim and Emacs).
Add vim-style-visual-feedback variable and documentation
2018-06-08 05:14:06 +00:00
To set the editing style set the variable =dotspacemacs-editing-style= to
either =vim=, =hybrid=, or =emacs=. It possible to pass a list of variables
as well with the keyword =:variables=, just like for layer variables.
doc: update doc on editing styles
2015-09-24 03:08:01 +00:00
*** Vim
Fix Evil URL
2017-05-24 12:30:31 +00:00
Spacemacs behaves like in Vim using the [[https://github.com/emacs-evil/evil/][Evil]] mode package to emulate Vim key
Correct minor errors in DOCUMENTATION.org
2016-12-18 20:34:56 +00:00
bindings. This is the default style of Spacemacs; it can be set explicitly by
setting the =dotspacemacs-editing-style= variable to =vim= in the dotfile.
doc: update doc on editing styles
2015-09-24 03:08:01 +00:00
doc: update editing style documentation
2016-03-18 00:38:04 +00:00
To bind keys in Vim editing style (=insert state=):
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(define-key evil-insert-state-map (kbd "C-]") 'forward-char)
doc: update editing style documentation
2016-03-18 00:38:04 +00:00
#+END_SRC
Add vim-style-visual-feedback variable and documentation
2018-06-08 05:14:06 +00:00
When setting the Vim style you can pass any variable supported by =evil-mode=
DOCUMENTATION.org: Fix typos
2018-11-10 19:51:11 +00:00
with the keyword =:variables=. Spacemacs also supports the following editing
Add vim-style-visual-feedback variable and documentation
2018-06-08 05:14:06 +00:00
style variables for Vim:
Rename Vim style related variable to vim-style-xxxxx Update the documentation Define alias for backward compatibility
2018-06-08 05:33:03 +00:00
| Variables | Description |
|------------------------------------------+-------------------------------------------------------------------------|
| =vim-style-visual-feedback= | If non-nil then objects are briefly highlighted |
| =vim-style-remap-Y-to-y$= | If non-nil ~Y~ is remapped to ~y$~ in Evil states |
| =vim-style-retain-visual-state-on-shift= | If non-nil, the shift mappings ~<~ and ~>~ retain visual state |
| =vim-style-visual-line-move-text= | If non-nil, ~J~ and ~K~ move lines up and down when in visual mode |
| =vim-style-ex-substitute-global= | If non-nil, inverse the meaning of ~g~ in =:substitute= Evil ex-command |
Add vim-style-visual-feedback variable and documentation
2018-06-08 05:14:06 +00:00
Default configuration is:
#+BEGIN_SRC emacs-lisp
Rename Vim style related variable to vim-style-xxxxx Update the documentation Define alias for backward compatibility
2018-06-08 05:33:03 +00:00
(setq-default dotspacemacs-editing-style '(vim :variables
Set default value of vim-style-visual-feedback to nil
2018-06-08 05:34:14 +00:00
vim-style-visual-feedback nil
Rename Vim style related variable to vim-style-xxxxx Update the documentation Define alias for backward compatibility
2018-06-08 05:33:03 +00:00
vim-style-remap-Y-to-y$ nil
vim-style-retain-visual-state-on-shift t
vim-style-visual-line-move-text nil
vim-style-ex-substitute-global nil)
Add vim-style-visual-feedback variable and documentation
2018-06-08 05:14:06 +00:00
#+END_SRC
doc: update doc on editing styles
2015-09-24 03:08:01 +00:00
*** Emacs
Spacemacs behaves like in raw Emacs using the Holy mode which configures Evil to
doc: update editing style documentation
2016-03-18 00:38:04 +00:00
make the =emacs state= the default state everywhere.
doc: update doc on editing styles
2015-09-24 03:08:01 +00:00
Set the =dotspacemacs-editing-style= variable to =emacs= in the dotfile.
doc: update editing style documentation
2016-03-18 00:38:04 +00:00
In Emacs style the leader is available on ~M-m~. It is possible to toggle it on
and off with ~SPC t E e~ and ~M-m t E e~. When off the =vim= style is enabled.
To bind keys in Emacs editing style (=emacs state=):
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(define-key evil-emacs-state-map (kbd "C-]") 'forward-char)
doc: update editing style documentation
2016-03-18 00:38:04 +00:00
#+END_SRC
doc: update doc on editing styles
2015-09-24 03:08:01 +00:00
*** Hybrid
doc: update editing style documentation
2016-03-18 00:38:04 +00:00
The hybrid editing style is like the Vim style except that =insert state= is
replaced by a new state called =hybrid state=. In =hybrid state= all the Emacs
Add small, non-structural fixes to documentation
2016-04-23 06:33:55 +00:00
key bindings are available; this is like replacing the =insert state= with the
doc: update editing style documentation
2016-03-18 00:38:04 +00:00
=emacs state= but provides an isolated key map =evil-hybrid-state-map=.
To bind keys in Hybrid editing style (=hybrid state=):
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(define-key evil-hybrid-state-map (kbd "C-]") 'forward-char)
doc: update editing style documentation
2016-03-18 00:38:04 +00:00
#+END_SRC
Update docs for new hybrid state The docs don't reflect the new design of hybrid mode
2015-09-20 22:10:49 +00:00
doc: update editing style documentation
2016-03-18 00:38:04 +00:00
This style can be tweaked to be more like Emacs or more like Vim depending
Fix some minor mistakes and typos in the documentation
2016-10-29 12:59:53 +00:00
on the user preferences. The following variables are available to change the
doc: update editing style documentation
2016-03-18 00:38:04 +00:00
style configuration:
Rename hybrid-mode-xxxx variables to hybrid-style-xxxx Use aliases to retain backward compatibility.
2018-06-08 05:52:02 +00:00
| Variables | Description |
|---------------------------------------+----------------------------------------------------------------------------------------|
Add hybrid-style-visual-feedback variable
2018-06-08 06:32:05 +00:00
| =hybrid-style-visual-feedback= | If non-nil then objects are briefly highlighted |
Rename hybrid-mode-xxxx variables to hybrid-style-xxxx Use aliases to retain backward compatibility.
2018-06-08 05:52:02 +00:00
| =hybrid-style-default-state= | The default state when opening a new buffer. Set it to =emacs= for a more emacsy style |
| =hybrid-style-enable-hjkl-bindings= | If non-nil then packages will configure =h j k l= key bindings for navigation |
| =hybrid-style-enable-evilified-state= | If non-nil buffer are =evilified= when supported, if nil then =emacs= state is enabled |
| =hybrid-style-use-evil-search-module= | If non-nil then use evil own search module which is closer to Vim search behavior |
doc: update editing style documentation
2016-03-18 00:38:04 +00:00
Default configuration is:
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(setq-default dotspacemacs-editing-style '(hybrid :variables
hybrid-style-visual-feedback nil
hybrid-style-enable-evilified-state t
hybrid-style-enable-hjkl-bindings nil
hybrid-style-use-evil-search-module nil
hybrid-style-default-state 'normal)
doc: update editing style documentation
2016-03-18 00:38:04 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
doc: update editing style documentation
2016-03-18 00:38:04 +00:00
To toggle the hybrid style on and off use ~SPC t E h~ and ~M-m t E h~. When
off the =vim= style is enabled.
Document hybrid-mode-default-state variable
2015-12-21 05:12:28 +00:00
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
** States
Spacemacs has 10 states:
| State | Default Color | Description |
|--------------+---------------+------------------------------------------------------------------------------------------------------------|
| normal | orange | like the =normal mode of Vim=, used to execute and combine commands |
| insert | green | like the =insert mode of Vim=, used to actually insert text |
| visual | gray | like the =visual mode of Vim=, used to make text selection |
| motion | purple | exclusive to =Evil=, used to navigate read only buffers |
| emacs | blue | exclusive to =Evil=, using this state is like using a regular Emacs without Vim |
Fix documentation about replace mode There is in fact a replace mode in vanilla Vim, see http://vimdoc.sourceforge.net/htmldoc/insert.html#mode-replace and not exclusive to Evil.
2016-12-20 21:03:11 +00:00
| replace | chocolate | like =replace mode of Vim=, overwrites the character under point instead of inserting a new one |
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
| hybrid | blue | exclusive to Spacemacs, this is like the insert state except that all the emacs key bindings are available |
| evilified | light brown | exclusive to Spacemacs, this is an =emacs state= modified to bring Vim navigation, selection and search. |
Fix export-breaking org links in documentation As discussed in #8054 and #8136, org doesn't always export links correctly if the syntax deviates from the one given on the org mode website. This results in broken links on github and/or spacemacs.org as in #6722, #8036, #8054, #7956 and possibly others. This modifies all links not already fixed in #8136. Internal links are handled with Custom IDs. External file links are formatted according to org guidelines as well (see bottom), and if they point to a specific headline in an external file, a custom ID is created as well. Fixes #6722, #8036, #7956, #7916 as well as other unreported broken links. http://orgmode.org/manual/External-links.html#External-links http://orgmode.org/manual/Internal-links.html#Internal-links TODO: make Custom IDs invisble in space-org-mode
2017-01-09 12:11:54 +00:00
| lisp | pink | exclusive to Spacemacs, used to navigate Lisp code and modify it (more [[#editing-lisp-code][info]]) |
| iedit | red | exclusive to Spacemacs, used to navigate between multiple regions of text using =iedit= (more [[#replacing-text-with-iedit][info]]) |
| iedit-insert | red | exclusive to Spacemacs, used to replace multiple regions of text using =iedit= (more [[#replacing-text-with-iedit][info]]) |
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
*Note*: Technically speaking there is also the =operator= evil state.
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
Document evilified modes [ci-skip]
2015-09-30 09:17:51 +00:00
** Evilified modes
documentation fixes: Tue Oct 23 14:18:21 UTC 2018
2018-10-23 14:18:21 +00:00
Some buffers are not for editing text and provide their own key bindings for
doc: update editing style documentation
2016-03-18 00:38:04 +00:00
certain operations. These often conflict with Vim bindings. To make such buffers
behave more like Vim in a consistent manner, they use a special state called
/evilified/ state. In evilified state, a handful of keys work as in Evil, namely
=/=, =:=, =h=, =j=, =k=, =l=, =n=, =N=, =v=, =V=, =gg=, =G=, =C-f=, =C-b=,
=C-d=, =C-e=, =C-u=, =C-y= and =C-z=. All other keys work as intended by the
underlying mode.
Document evilified modes [ci-skip]
2015-09-30 09:17:51 +00:00
Shadowed keys are moved according to the pattern: =a= → =A= → =C-a= → =C-A=
For example, if the mode binds a function to =n=, that is found under =C-n= in
Clarify evilified rules
2015-10-05 20:07:17 +00:00
evilified state, since both =n= and =N= are reserved, but =C-n= is not. On the
other hand, anything originally bound to =k= will be found on =K=, since =k= is
reserved but =K= is not. If there is a binding on =K=, that will be moved to
=C-k=.
Document evilified modes [ci-skip]
2015-09-30 09:17:51 +00:00
In addition to this, =C-g=, being an important escape key in Emacs, is skipped.
So anything bound to =g= originally will be found on =C-G=, since =g=, =G= and
Clarify evilified rules
2015-10-05 20:07:17 +00:00
=C-g= are all reserved.
Document evilified modes [ci-skip]
2015-09-30 09:17:51 +00:00
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
** Evil leader
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
Spacemacs uses a leader key to bind almost all its key bindings.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
This leader key is commonly set to ~​,​~ by Vim users. In Spacemacs the leader
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
key is set on ~SPC~ (the space bar, hence the name =spacemacs=). This key is the
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
most accessible key on a keyboard and it is pressed with the thumb which is a
Change HTTP to HTTPS in docs
2017-05-16 12:18:50 +00:00
good choice to lower the risk of [[https://en.wikipedia.org/wiki/Repetitive_strain_injury][RSI]]. It can be customized to any other key
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
using the variable =dotspacemacs-leader-key= and =dotspacemacs-emacs-leader-key=.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
With Spacemacs there is no need to remap your keyboard modifiers to attempt
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
to reduce the risk of RSI, every command can be executed very easily while you
are in =normal= mode by pressing the ~SPC~ leader key, here are a few examples:
Reformat documentation
2018-09-19 03:54:47 +00:00
- Save a buffer: ~SPC f s~
- Save all opened buffers: ~SPC f S~
- Open (switch) to a buffer: ~SPC b b~
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
** Universal argument
The universal argument ~C-u~ is an important command in Emacs but it is also a
very handy Vim key binding to scroll up.
Fix some minor mistakes and typos in the documentation
2016-10-29 12:59:53 +00:00
Spacemacs binds ~C-u~ to =scroll-up= and changes the universal argument binding
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
to ~SPC u~.
Change all references of micro-state in codebase to transient-state
2016-01-30 11:32:53 +00:00
** Transient-states
Doc: transient-state => transient state
2016-03-21 02:08:49 +00:00
Spacemacs defines a wide variety of =transient states= (temporary overlay maps)
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
where it makes sense. This prevents one from doing repetitive and tedious
presses on the ~SPC~ key.
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
When a =transient state= is active, documentation is displayed in the
minibuffer. Additional information may also be displayed in the minibuffer.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Doc: transient-state => transient state
2016-03-21 02:08:49 +00:00
Auto-highlight-symbol transient state:
Change all references of micro-state in codebase to transient-state
2016-01-30 11:32:53 +00:00
[[file:img/spacemacs-ahs-transient-state.png]]
Fix export-breaking org links in documentation As discussed in #8054 and #8136, org doesn't always export links correctly if the syntax deviates from the one given on the org mode website. This results in broken links on github and/or spacemacs.org as in #6722, #8036, #8054, #7956 and possibly others. This modifies all links not already fixed in #8136. Internal links are handled with Custom IDs. External file links are formatted according to org guidelines as well (see bottom), and if they point to a specific headline in an external file, a custom ID is created as well. Fixes #6722, #8036, #7956, #7916 as well as other unreported broken links. http://orgmode.org/manual/External-links.html#External-links http://orgmode.org/manual/Internal-links.html#Internal-links TODO: make Custom IDs invisble in space-org-mode
2017-01-09 12:11:54 +00:00
[[#text][Text scale transient state]]:
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
Change all references of micro-state in codebase to transient-state
2016-01-30 11:32:53 +00:00
[[file:img/spacemacs-scale-transient-state.png]]
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
core: add support for major mode specific toggles Modify macro spacemacs|add-toggle to create additional sets of functions for each supported modes when the toggle is major mode specific. A toggle is major mode specific when it is bound to keys using the keyword :evil-leader-for-mode Updare documentation to add a section on toggles in the Spacemacs concepts.
2018-01-04 05:03:22 +00:00
** Toggles
Spacemacs tries to unify the interface to handle toggles using a custom macro
called =spacemacs|add-toggle=.
There exists two type of toggles:
- globally available toggles under the key prefixes ~SPC t~ and ~SPC T~
- major mode specific toggles under the key prefix ~SPC m T~
When a toggle is turned on a unicode symbol is displayed in the mode-line, this
symbol is a circled letter for globally available toggles and a plain squared
letter for major mode specific toggles. The letter corresponds to the key
binding for this toggle.
For instance the globally available toggle for =which-key= is under ~SPC t K~
and its corresponding symbol in the mode-line is =Ⓚ=. Also the major mode
specific toggle for =nameless= available only in =emacs-lisp= mode is under
[doc] Fix typos and add missing/remove extra ~ Add missing ~ (tilde) around key bindings. Remove an extra ~.
2019-06-01 17:13:30 +00:00
~SPC m T n~ and its corresponding symbol in the mode-line is =🅽=.
core: add support for major mode specific toggles Modify macro spacemacs|add-toggle to create additional sets of functions for each supported modes when the toggle is major mode specific. A toggle is major mode specific when it is bound to keys using the keyword :evil-leader-for-mode Updare documentation to add a section on toggles in the Spacemacs concepts.
2018-01-04 05:03:22 +00:00
All toggles can be browsed via the Spacemacs help system under ~SPC h t~.
*** Configuring toggles in the dotfile
To set the toggle states to your preference you can use a set of functions
that should be called in your =dotspacemacs/user-config= function of your
dotfile.
Globally available toggles can be turned on and off using the functions
=spacemacs/toggle-NAME-on= and =spacemacs/toggle-NAME-off= respectively.
=NAME= corresponds to the name of the toggle, for instance =which-key=
for the toggle to turn on and off the =which-key= minor mode.
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(spacemacs/toggle-which-key-on)
core: add support for major mode specific toggles Modify macro spacemacs|add-toggle to create additional sets of functions for each supported modes when the toggle is major mode specific. A toggle is major mode specific when it is bound to keys using the keyword :evil-leader-for-mode Updare documentation to add a section on toggles in the Spacemacs concepts.
2018-01-04 05:03:22 +00:00
#+END_SRC
Major mode specific toggles can be turned on by registering a hook on them to
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
call the "toggle on" function automatically whenever a buffer using this major
Fix some typos (#14832)
2021-06-06 23:43:22 +00:00
mode is opened. It can be done conveniently using the function
core: add support for major mode specific toggles Modify macro spacemacs|add-toggle to create additional sets of functions for each supported modes when the toggle is major mode specific. A toggle is major mode specific when it is bound to keys using the keyword :evil-leader-for-mode Updare documentation to add a section on toggles in the Spacemacs concepts.
2018-01-04 05:03:22 +00:00
=spacemacs/toggle-NAME-on-register-hooks=. It also exists variants of this
function for each supported major mode like
=spacemacs/toggle-NAME-on-register-hook-MODE=.
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(spacemacs/toggle-nameless-on-register-hooks)
;; or to enable it for emacs-lips buffers only
(spacemacs/toggle-nameless-on-register-hook-emacs-lisp-mode)
core: add support for major mode specific toggles Modify macro spacemacs|add-toggle to create additional sets of functions for each supported modes when the toggle is major mode specific. A toggle is major mode specific when it is bound to keys using the keyword :evil-leader-for-mode Updare documentation to add a section on toggles in the Spacemacs concepts.
2018-01-04 05:03:22 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
* Differences between Vim, Evil and Spacemacs
Reformat documentation
2018-09-19 03:54:47 +00:00
- The ~​,​~ key does repeat last ~f~, ~t~, ~F~, or ~T~ command in
doc: Be consistent with ref to Spacemacs Use of =Spacemacs= vs Spacemacs is inconsistent. This picks Spacemacs as a convention
2015-10-12 23:12:09 +00:00
opposite direction in =Vim=, but in Spacemacs it is the major mode specific
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
leader key by default (which can be set on another key binding in the
dotfile).
Send a PR to add the differences you found in this section.
** The vim-surround case
There is one obvious visible difference though. It is not between =Evil= and
core: add support for major mode specific toggles Modify macro spacemacs|add-toggle to create additional sets of functions for each supported modes when the toggle is major mode specific. A toggle is major mode specific when it is bound to keys using the keyword :evil-leader-for-mode Updare documentation to add a section on toggles in the Spacemacs concepts.
2018-01-04 05:03:22 +00:00
=Vim= but between Spacemacs and [[https://github.com/tpope/vim-surround][vim-surround]]: in visual mode the =surround=
command is on ~S~ in =vim-surround= whereas it is on ~s~ in Spacemacs.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
This is something that can surprise some Vim users so here are some motivations
behind this change:
Reformat documentation
2018-09-19 03:54:47 +00:00
- ~s~ and ~c~ do the same thing in =visual state=,
- ~s~ is only useful to delete /one/ character and add more than one character
which is a /very/ narrow use case
- ~c~ accept motions and can do everything ~s~ can do in =normal state=
(note that this is also true for ~r~ but ~r~ is more useful because it
stays in =normal state=)
- =surround= command is just a more powerful command than ~s~.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
If you are not convinced, then here is the snippet to revert back to the default
core: add support for major mode specific toggles Modify macro spacemacs|add-toggle to create additional sets of functions for each supported modes when the toggle is major mode specific. A toggle is major mode specific when it is bound to keys using the keyword :evil-leader-for-mode Updare documentation to add a section on toggles in the Spacemacs concepts.
2018-01-04 05:03:22 +00:00
=Vim + vim-surround= setup (add it to your =dotspacemacs/user-config=):
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(evil-define-key 'visual evil-surround-mode-map "s" 'evil-substitute)
(evil-define-key 'visual evil-surround-mode-map "S" 'evil-surround-region)
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
* Evil plugins
doc: Be consistent with ref to Spacemacs Use of =Spacemacs= vs Spacemacs is inconsistent. This picks Spacemacs as a convention
2015-10-12 23:12:09 +00:00
Spacemacs ships with the following evil plugins:
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
documentation formatting: Sun Jan 20 15:34:11 UTC 2019
2019-01-20 15:34:11 +00:00
| Mode | Description |
|-------------------------------+--------------------------------------------|
| [[https://github.com/wcsmith/evil-args][evil-args]] | motions and text objects for arguments |
| [[https://github.com/Dewdrops/evil-exchange][evil-exchange]] | port of [[https://github.com/tommcdo/vim-exchange][vim-exchange]] |
| [[https://github.com/cofi/evil-indent-textobject][evil-indent-textobject]] | add text object based on indentation level |
| [[https://github.com/redguardtoo/evil-matchit][evil-matchit]] | port of [[http://www.vim.org/scripts/script.php?script_id=39][matchit.vim]] |
| [[https://github.com/redguardtoo/evil-nerd-commenter][evil-nerd-commenter]] | port of [[https://github.com/scrooloose/nerdcommenter][nerdcommenter]] |
| [[https://github.com/cofi/evil-numbers][evil-numbers]] | like ~C-a~ and ~C-x~ in vim |
| [[https://github.com/juanjux/evil-search-highlight-persist][evil-search-highlight-persist]] | emulation of hlsearch behavior |
| [[https://github.com/timcharper/evil-surround][evil-surround]] | port of [[https://github.com/tpope/vim-surround][vim-surround]] |
| [[https://github.com/bling/evil-visualstar][evil-visualstar]] | search for current selection with ~*~ |
| [[https://github.com/Alexander-Miller/treemacs][Treemacs]] | a file explorer like [[https://github.com/scrooloose/nerdtree][NERD Tree]] |
Minor indentation fix of some tables in DOCUMENTATION.org
2015-07-05 04:02:50 +00:00
core: rework environment variables and PATH management See updated DOCUMENTATION.org and FAQ.org for more info. * add core-env.el * add library load-env-vars.el * add bootstrap package dotenv-mode.el * remove spacemacs-environment from bootstrap layer * remove dotspacemacs variable dotspacemacs-import-env-vars-from-shell * remove dotspacemacs variable dotspacemacs-improt-env-vars-shell-file-name * add new key binding SPC f e e to open spacemacs.env file * add new key binding SPC f e E to reload environment variable from env file * add new key binding SPC f e C-e to re-initialize the env file from shell.
2018-06-25 06:16:27 +00:00
* Environment variables and PATH
core: update environment variables management * add new dotfile function `dotspacemacs/user-env` * add ignored env. vars with variable spacemacs-ignored-environment-variables * ignore env vars: SSH_AUTH_SOCK and DBUS_SESSION_BUS_ADDRESS * update documentation in DOCUMENTATION.org * update .spacemacs.template with new function * rename environment file from spacemacs.env to .spacemacs.env * move location of .spacemacs.env file to home or dotdirectory * add a header to the generated .spacemacs.env file to explain what it is * make SPC f e e fallbacks to the function dotspacemacs/user-env if the user manages the env var by themselves * make SPC f e E call the new function dotspacemacs/user-env * sort environment variables in .spacemacs.env file
2018-07-03 05:20:06 +00:00
Environment variables are handled by the function =dotspacemacs/user-env= of
your dotfile.
core: rework environment variables and PATH management See updated DOCUMENTATION.org and FAQ.org for more info. * add core-env.el * add library load-env-vars.el * add bootstrap package dotenv-mode.el * remove spacemacs-environment from bootstrap layer * remove dotspacemacs variable dotspacemacs-import-env-vars-from-shell * remove dotspacemacs variable dotspacemacs-improt-env-vars-shell-file-name * add new key binding SPC f e e to open spacemacs.env file * add new key binding SPC f e E to reload environment variable from env file * add new key binding SPC f e C-e to re-initialize the env file from shell.
2018-06-25 06:16:27 +00:00
core: update environment variables management * add new dotfile function `dotspacemacs/user-env` * add ignored env. vars with variable spacemacs-ignored-environment-variables * ignore env vars: SSH_AUTH_SOCK and DBUS_SESSION_BUS_ADDRESS * update documentation in DOCUMENTATION.org * update .spacemacs.template with new function * rename environment file from spacemacs.env to .spacemacs.env * move location of .spacemacs.env file to home or dotdirectory * add a header to the generated .spacemacs.env file to explain what it is * make SPC f e e fallbacks to the function dotspacemacs/user-env if the user manages the env var by themselves * make SPC f e E call the new function dotspacemacs/user-env * sort environment variables in .spacemacs.env file
2018-07-03 05:20:06 +00:00
** Default behavior
By default, the function =dotspacemacs/user-env= only calls the function
=spacemacs/load-spacemacs-env= which loads the environment variables from
the file =~/.spacemacs.env=. This file is automatically created for you by
Spacemacs and it is initialized with the environment variables of your
system as well as the environment variables of your default shell.
core: rework environment variables and PATH management See updated DOCUMENTATION.org and FAQ.org for more info. * add core-env.el * add library load-env-vars.el * add bootstrap package dotenv-mode.el * remove spacemacs-environment from bootstrap layer * remove dotspacemacs variable dotspacemacs-import-env-vars-from-shell * remove dotspacemacs variable dotspacemacs-improt-env-vars-shell-file-name * add new key binding SPC f e e to open spacemacs.env file * add new key binding SPC f e E to reload environment variable from env file * add new key binding SPC f e C-e to re-initialize the env file from shell.
2018-06-25 06:16:27 +00:00
core: update environment variables management * add new dotfile function `dotspacemacs/user-env` * add ignored env. vars with variable spacemacs-ignored-environment-variables * ignore env vars: SSH_AUTH_SOCK and DBUS_SESSION_BUS_ADDRESS * update documentation in DOCUMENTATION.org * update .spacemacs.template with new function * rename environment file from spacemacs.env to .spacemacs.env * move location of .spacemacs.env file to home or dotdirectory * add a header to the generated .spacemacs.env file to explain what it is * make SPC f e e fallbacks to the function dotspacemacs/user-env if the user manages the env var by themselves * make SPC f e E call the new function dotspacemacs/user-env * sort environment variables in .spacemacs.env file
2018-07-03 05:20:06 +00:00
To open this file use ~SPC f e e~. You can edit it to change or add/remove
environment variables. Use ~SPC f e E~ to reload it.
core: rework environment variables and PATH management See updated DOCUMENTATION.org and FAQ.org for more info. * add core-env.el * add library load-env-vars.el * add bootstrap package dotenv-mode.el * remove spacemacs-environment from bootstrap layer * remove dotspacemacs variable dotspacemacs-import-env-vars-from-shell * remove dotspacemacs variable dotspacemacs-improt-env-vars-shell-file-name * add new key binding SPC f e e to open spacemacs.env file * add new key binding SPC f e E to reload environment variable from env file * add new key binding SPC f e C-e to re-initialize the env file from shell.
2018-06-25 06:16:27 +00:00
core: update environment variables management * add new dotfile function `dotspacemacs/user-env` * add ignored env. vars with variable spacemacs-ignored-environment-variables * ignore env vars: SSH_AUTH_SOCK and DBUS_SESSION_BUS_ADDRESS * update documentation in DOCUMENTATION.org * update .spacemacs.template with new function * rename environment file from spacemacs.env to .spacemacs.env * move location of .spacemacs.env file to home or dotdirectory * add a header to the generated .spacemacs.env file to explain what it is * make SPC f e e fallbacks to the function dotspacemacs/user-env if the user manages the env var by themselves * make SPC f e E call the new function dotspacemacs/user-env * sort environment variables in .spacemacs.env file
2018-07-03 05:20:06 +00:00
Some dynamic environment variables are ignored by Spacemacs when it first
creates the =~/.spacemacs.env= file. These ignored variables are listed in
the variable =spacemacs-ignored-environment-variables=.
core: rework environment variables and PATH management See updated DOCUMENTATION.org and FAQ.org for more info. * add core-env.el * add library load-env-vars.el * add bootstrap package dotenv-mode.el * remove spacemacs-environment from bootstrap layer * remove dotspacemacs variable dotspacemacs-import-env-vars-from-shell * remove dotspacemacs variable dotspacemacs-improt-env-vars-shell-file-name * add new key binding SPC f e e to open spacemacs.env file * add new key binding SPC f e E to reload environment variable from env file * add new key binding SPC f e C-e to re-initialize the env file from shell.
2018-06-25 06:16:27 +00:00
First part of review and tweaks of release notes
2019-01-29 04:08:46 +00:00
It is possible to force a new import of system and shell environment variables
core: update environment variables management * add new dotfile function `dotspacemacs/user-env` * add ignored env. vars with variable spacemacs-ignored-environment-variables * ignore env vars: SSH_AUTH_SOCK and DBUS_SESSION_BUS_ADDRESS * update documentation in DOCUMENTATION.org * update .spacemacs.template with new function * rename environment file from spacemacs.env to .spacemacs.env * move location of .spacemacs.env file to home or dotdirectory * add a header to the generated .spacemacs.env file to explain what it is * make SPC f e e fallbacks to the function dotspacemacs/user-env if the user manages the env var by themselves * make SPC f e E call the new function dotspacemacs/user-env * sort environment variables in .spacemacs.env file
2018-07-03 05:20:06 +00:00
with ~SPC f e C-e~. Note that this action will overwrite =~/.spacemacs.env=.
core: rework environment variables and PATH management See updated DOCUMENTATION.org and FAQ.org for more info. * add core-env.el * add library load-env-vars.el * add bootstrap package dotenv-mode.el * remove spacemacs-environment from bootstrap layer * remove dotspacemacs variable dotspacemacs-import-env-vars-from-shell * remove dotspacemacs variable dotspacemacs-improt-env-vars-shell-file-name * add new key binding SPC f e e to open spacemacs.env file * add new key binding SPC f e E to reload environment variable from env file * add new key binding SPC f e C-e to re-initialize the env file from shell.
2018-06-25 06:16:27 +00:00
core: update environment variables management * add new dotfile function `dotspacemacs/user-env` * add ignored env. vars with variable spacemacs-ignored-environment-variables * ignore env vars: SSH_AUTH_SOCK and DBUS_SESSION_BUS_ADDRESS * update documentation in DOCUMENTATION.org * update .spacemacs.template with new function * rename environment file from spacemacs.env to .spacemacs.env * move location of .spacemacs.env file to home or dotdirectory * add a header to the generated .spacemacs.env file to explain what it is * make SPC f e e fallbacks to the function dotspacemacs/user-env if the user manages the env var by themselves * make SPC f e E call the new function dotspacemacs/user-env * sort environment variables in .spacemacs.env file
2018-07-03 05:20:06 +00:00
** Managing environment variables by yourself
For full flexibility you can bypass the default behavior simply by removing
the call to =spacemacs/load-spacemacs-env= from your =dotspacemacs/user-env=
function.
From there you can choose to use the popular package =exec-path-from-shell=
or just call built-in functions like =setenv= or =(add-to-list 'exec-path ...)=.
If you choose to handle the environment variables by yourself then ~SPC f e e~
will go to the function =dotspacemacs/user-env= instead of opening the file
=~/.spacemacs.env=. In all cases ~SPC f e E~ calls the function
=dotspacemacs/user-env= so you can update your variables in place.
** Note about the function dotspacemacs/user-env
Add missing apostrophe in DOCUMENTATION.org
2019-12-27 22:49:03 +00:00
It's possible that you don't have this function defined if you have an older
core: update environment variables management * add new dotfile function `dotspacemacs/user-env` * add ignored env. vars with variable spacemacs-ignored-environment-variables * ignore env vars: SSH_AUTH_SOCK and DBUS_SESSION_BUS_ADDRESS * update documentation in DOCUMENTATION.org * update .spacemacs.template with new function * rename environment file from spacemacs.env to .spacemacs.env * move location of .spacemacs.env file to home or dotdirectory * add a header to the generated .spacemacs.env file to explain what it is * make SPC f e e fallbacks to the function dotspacemacs/user-env if the user manages the env var by themselves * make SPC f e E call the new function dotspacemacs/user-env * sort environment variables in .spacemacs.env file
2018-07-03 05:20:06 +00:00
dotfile. It is recommended to update your dotfile by adding this function,
see the file =~/.emacs.d/core/template/.spacemacs.template= to copy it.
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
If you don't create such function then Spacemacs assumes you are using the
core: update environment variables management * add new dotfile function `dotspacemacs/user-env` * add ignored env. vars with variable spacemacs-ignored-environment-variables * ignore env vars: SSH_AUTH_SOCK and DBUS_SESSION_BUS_ADDRESS * update documentation in DOCUMENTATION.org * update .spacemacs.template with new function * rename environment file from spacemacs.env to .spacemacs.env * move location of .spacemacs.env file to home or dotdirectory * add a header to the generated .spacemacs.env file to explain what it is * make SPC f e e fallbacks to the function dotspacemacs/user-env if the user manages the env var by themselves * make SPC f e E call the new function dotspacemacs/user-env * sort environment variables in .spacemacs.env file
2018-07-03 05:20:06 +00:00
default behavior described above.
core: rework environment variables and PATH management See updated DOCUMENTATION.org and FAQ.org for more info. * add core-env.el * add library load-env-vars.el * add bootstrap package dotenv-mode.el * remove spacemacs-environment from bootstrap layer * remove dotspacemacs variable dotspacemacs-import-env-vars-from-shell * remove dotspacemacs variable dotspacemacs-improt-env-vars-shell-file-name * add new key binding SPC f e e to open spacemacs.env file * add new key binding SPC f e E to reload environment variable from env file * add new key binding SPC f e C-e to re-initialize the env file from shell.
2018-06-25 06:16:27 +00:00
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
* Binding keys
doc: DOCUMENTATION.org: upd Binding keys: direct to key Conventions
2019-04-07 13:25:48 +00:00
To be compatible with all Spacemacs bindings, please refer to [[https://github.com/syl20bnr/spacemacs/blob/master/doc/CONVENTIONS.org#key-bindings-conventions][Conventions]].
In brief, ~SPC o~ is reserved for user custom bindings in =global-map=,
and ~SPC m o~ in major modes.
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
Key sequences are bound to commands in Emacs in various keymaps. The most basic
map is the =global-map=. Setting a key binding in the =global-map= is achieved
with the function =global-set-key=. Example to bind a key to the command
=forward-char=:
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(global-set-key (kbd "C-]") 'forward-char)
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
#+END_SRC
The =kbd= macro accepts a string describing a key sequence. The =global-map= is
often shadowed by other maps. For example, =evil-mode= defines keymaps that
target states (or modes in vim terminology). Here is an example that creates the
same binding as above but only in =insert state= (=define-key= is a built-in
function. =Evil-mode= has its own functions for defining keys).
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(define-key evil-insert-state-map (kbd "C-]") 'forward-char)
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
#+END_SRC
Perhaps most importantly for Spacemacs is the use of the bind-map package to
bind keys behind a leader key.
This is where most of the Spacemacs bindings live. Binding keys behind the
leader key is achieved with the functions =spacemacs/set-leader-keys= and
=spacemacs/set-leader-keys-for-major-mode=, example:
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(spacemacs/set-leader-keys "C-]" 'forward-char)
(spacemacs/set-leader-keys-for-major-mode 'emacs-lisp-mode "C-]" 'forward-char)
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
#+END_SRC
These functions use a macro like =kbd= to translate the key sequences for you.
The second function, =spacemacs/set-leader-keys-for-major-mode=, binds the key
only in the specified mode. The second key binding is active only when the
major mode is =emacs-lisp=.
Finally, one should be aware of prefix keys. Essentially, all keymaps can be
nested. Nested keymaps are used extensively in spacemacs, and in vanilla Emacs
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
for that matter. For example, ~SPC a~ points to key bindings for "applications",
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
like ~SPC a c~ for =calc-dispatch=. Nesting bindings is easy.
#+BEGIN_SRC emacs-lisp
Fix partial merge of last doc update Just cherry picked the last commit in the previous PR and noticed that I have just got part of the changes due to multiple commits in the PR. However as I did already push I am now providing the missing changes manually rather than to rollback the commit.
2019-04-09 22:05:32 +00:00
(spacemacs/declare-prefix "o" "custom")
(spacemacs/set-leader-keys "oc" 'my-custom-command)
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
#+END_SRC
Fix partial merge of last doc update Just cherry picked the last commit in the previous PR and noticed that I have just got part of the changes due to multiple commits in the PR. However as I did already push I am now providing the missing changes manually rather than to rollback the commit.
2019-04-09 22:05:32 +00:00
The first line declares ~SPC o~ to be a prefix and the second binds the key
sequence ~SPC oc~ to the corresponding command. The first line is actually
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
unnecessary to create the prefix, but it will give your new prefix a name that
key-discovery tools can use (e.g., which-key).
Fix partial merge of last doc update Just cherry picked the last commit in the previous PR and noticed that I have just got part of the changes due to multiple commits in the PR. However as I did already push I am now providing the missing changes manually rather than to rollback the commit.
2019-04-09 22:05:32 +00:00
Example to create binding in major mode:
documentation formatting: Wed Apr 10 18:17:02 UTC 2019
2019-04-10 18:17:02 +00:00
#+BEGIN_SRC emacs-lisp
Fix major-mode set key prefix documentation
2020-11-15 16:19:51 +00:00
(spacemacs/declare-prefix-for-mode 'org-mode "mo" "custom")
Fix partial merge of last doc update Just cherry picked the last commit in the previous PR and noticed that I have just got part of the changes due to multiple commits in the PR. However as I did already push I am now providing the missing changes manually rather than to rollback the commit.
2019-04-09 22:05:32 +00:00
(spacemacs/set-leader-keys-for-major-mode 'org-mode "oi" 'org-id-get-create)
documentation formatting: Wed Apr 10 18:17:02 UTC 2019
2019-04-10 18:17:02 +00:00
#+END_SRC
Fix partial merge of last doc update Just cherry picked the last commit in the previous PR and noticed that I have just got part of the changes due to multiple commits in the PR. However as I did already push I am now providing the missing changes manually rather than to rollback the commit.
2019-04-09 22:05:32 +00:00
Fix major-mode set key prefix documentation
2020-11-15 16:19:51 +00:00
This would add binding as ~, oi~ and ~SPC moi~ (note that the "m" in the prefix
declaration must be include).
Fix partial merge of last doc update Just cherry picked the last commit in the previous PR and noticed that I have just got part of the changes due to multiple commits in the PR. However as I did already push I am now providing the missing changes manually rather than to rollback the commit.
2019-04-09 22:05:32 +00:00
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
There is much more to say about bindings keys, but these are the basics. Keys
can be bound in your =~/.spacemacs= file or in individual layers.
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
* GUI Elements
doc: Be consistent with ref to Spacemacs Use of =Spacemacs= vs Spacemacs is inconsistent. This picks Spacemacs as a convention
2015-10-12 23:12:09 +00:00
Spacemacs has a minimalistic and distraction free graphical UI:
Reformat documentation
2018-09-19 03:54:47 +00:00
- custom [[https://github.com/milkypostman/powerline][powerline]] mode-line [[#flycheck-integration][with color feedback]] according to current [[https://github.com/flycheck/flycheck][Flycheck]] status
- Unicode symbols for minor mode lighters which appear in the mode-line
- [[#errors-handling][custom fringe bitmaps]] and error feedbacks for [[https://github.com/flycheck/flycheck][Flycheck]]
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
** Color themes
core: dotspacemacs-themes entries now accept package properties It is now possible to use package properties like :location in dotspacemacs-themes. Added hooks ran at the beginning and end of configuration-layer/sync: - configuration-layer-pre-sync-hook - configuration-layer-post-sync-hook configuration-layer-pre-sync-hook is used to hook the new function spacemacs//add-theme-packages-to-additional-packages. This new function updates dotspacemacs--additional-theme-packages variables. Update documentation to mention the new feature.
2017-02-02 03:59:03 +00:00
*** Default theme
doc: Be consistent with ref to Spacemacs Use of =Spacemacs= vs Spacemacs is inconsistent. This picks Spacemacs as a convention
2015-10-12 23:12:09 +00:00
The official Spacemacs theme is [[https://github.com/nashamri/spacemacs-theme][spacemacs-dark]] and it is the default theme
installed when you first started Spacemacs. There are two variants of the
Fix some minor mistakes and typos in the documentation
2016-10-29 12:59:53 +00:00
theme, a dark one and a light one. Some aspects of these themes can be customized
Update .spacemacs function names in DOCUMENTATION.org. dotspacemacs/init -> dotspacemacs/user-init dotspacemacs/config -> dotspacemacs/user-config
2015-09-05 07:55:28 +00:00
in the function =dotspacemacs/user-init= of your =~/.spacemacs=:
Reformat documentation
2018-09-19 03:54:47 +00:00
- the comment background with the boolean =spacemacs-theme-comment-bg=
- the height of org section titles with =spacemacs-theme-org-height=
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
core: dotspacemacs-themes entries now accept package properties It is now possible to use package properties like :location in dotspacemacs-themes. Added hooks ran at the beginning and end of configuration-layer/sync: - configuration-layer-pre-sync-hook - configuration-layer-post-sync-hook configuration-layer-pre-sync-hook is used to hook the new function spacemacs//add-theme-packages-to-additional-packages. This new function updates dotspacemacs--additional-theme-packages variables. Update documentation to mention the new feature.
2017-02-02 03:59:03 +00:00
*** Choosing themes
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
It is possible to define your default themes in your =~/.spacemacs= with the
Remove references to Solarized themes Solarized themes has been removed from the default distribution of Spacemacs.
2016-02-19 20:02:21 +00:00
variable =dotspacemacs-themes=. For instance, to specify =spacemacs-light=,
Add documentation for spacemacs-theme
2015-07-05 04:02:37 +00:00
=leuven= and =zenburn=:
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(setq-default dotspacemacs-themes '(spacemacs-light leuven zenburn))
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
core: dotspacemacs-themes entries now accept package properties It is now possible to use package properties like :location in dotspacemacs-themes. Added hooks ran at the beginning and end of configuration-layer/sync: - configuration-layer-pre-sync-hook - configuration-layer-post-sync-hook configuration-layer-pre-sync-hook is used to hook the new function spacemacs//add-theme-packages-to-additional-packages. This new function updates dotspacemacs--additional-theme-packages variables. Update documentation to mention the new feature.
2017-02-02 03:59:03 +00:00
=dotspacemacs-themes= entries accept the same properties as packages listed
Fix typos in documentation
2017-05-01 19:56:04 +00:00
in layers package lists or in =dotspacemacs-additional-packages=. So it is
core: dotspacemacs-themes entries now accept package properties It is now possible to use package properties like :location in dotspacemacs-themes. Added hooks ran at the beginning and end of configuration-layer/sync: - configuration-layer-pre-sync-hook - configuration-layer-post-sync-hook configuration-layer-pre-sync-hook is used to hook the new function spacemacs//add-theme-packages-to-additional-packages. This new function updates dotspacemacs--additional-theme-packages variables. Update documentation to mention the new feature.
2017-02-02 03:59:03 +00:00
possible to fetch a package from a specific location. For example, you could
fetch =zenburn= theme directly from the GitHub repository with the following
declaration:
#+BEGIN_SRC emacs-lisp
Documentation fixes. Fixes: - Typo - Code block indentation - Put keybindings on one line so they look nicer when viewed in Spacemacs - Make one sentence sound better
2017-04-18 06:05:28 +00:00
(setq-default dotspacemacs-themes
'(spacemacs-light
leuven
(zenburn :location (recipe :fetcher github
:repo "bbatsov/zenburn-emacs"))
))
core: dotspacemacs-themes entries now accept package properties It is now possible to use package properties like :location in dotspacemacs-themes. Added hooks ran at the beginning and end of configuration-layer/sync: - configuration-layer-pre-sync-hook - configuration-layer-post-sync-hook configuration-layer-pre-sync-hook is used to hook the new function spacemacs//add-theme-packages-to-additional-packages. This new function updates dotspacemacs--additional-theme-packages variables. Update documentation to mention the new feature.
2017-02-02 03:59:03 +00:00
#+END_SRC
core: add support for :location keyword in dotspacemacs-themes New functions: - configuration-layer/get-location-directory which return the location on disk given a location - spacemacs//get-theme-directory which returns the location on disk of the theme Add note in documentation to warn about the directory name when :location local is used, the directory name is the package name not the theme name.
2017-02-06 04:01:50 +00:00
*Important note:* If you use =:location local= then you have to put your theme
in the directory =private/local/<theme-package-name>/= with =theme-package-name=
being the name of your package suffixed with =-theme= as mentioned in the Emacs
conventions.
For instance if your theme is =foo= then you have to put our theme
files in the directory =private/local/foo-theme=.
core: dotspacemacs-themes entries now accept package properties It is now possible to use package properties like :location in dotspacemacs-themes. Added hooks ran at the beginning and end of configuration-layer/sync: - configuration-layer-pre-sync-hook - configuration-layer-post-sync-hook configuration-layer-pre-sync-hook is used to hook the new function spacemacs//add-theme-packages-to-additional-packages. This new function updates dotspacemacs--additional-theme-packages variables. Update documentation to mention the new feature.
2017-02-02 03:59:03 +00:00
You can cycle between the themes declared in =dotspacemacs-themes= with
~SPC T n~ and select an installed theme with ~SPC T s~.
Update themes transient state, t for helm-themes Add the key binding: t to open helm-themes, without having to use the arrow up key. Reorder/rename: cycles backward and cycles forward to: next and previous Next is listed first, because it's the most common action, and it matches the order in other transient states. Change the t argument in the call to spacemacs/cycle-spacemacs-theme, to the symbol 'backward, to make it clear what the argument does. Add documentation for the Themes Transient State bindings.
2017-10-20 12:20:26 +00:00
**** Themes Transient State
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Update themes transient state, t for helm-themes Add the key binding: t to open helm-themes, without having to use the arrow up key. Reorder/rename: cycles backward and cycles forward to: next and previous Next is listed first, because it's the most common action, and it matches the order in other transient states. Change the t argument in the call to spacemacs/cycle-spacemacs-theme, to the symbol 'backward, to make it clear what the argument does. Add documentation for the Themes Transient State bindings.
2017-10-20 12:20:26 +00:00
|------------------+-----------------------------------------------|
| ~n~ or ~<right>~ | change to the next theme |
| ~p~ or ~<left>~ | change to the previous theme |
| ~t~ or ~<up>~ | open helm-themes to select an installed theme |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
core: dotspacemacs-themes entries now accept package properties It is now possible to use package properties like :location in dotspacemacs-themes. Added hooks ran at the beginning and end of configuration-layer/sync: - configuration-layer-pre-sync-hook - configuration-layer-post-sync-hook configuration-layer-pre-sync-hook is used to hook the new function spacemacs//add-theme-packages-to-additional-packages. This new function updates dotspacemacs--additional-theme-packages variables. Update documentation to mention the new feature.
2017-02-02 03:59:03 +00:00
*** Browsing themes
You can see samples of all themes included in the =themes-megapack= layer
Change HTTP to HTTPS in docs
2017-05-16 12:18:50 +00:00
in this [[http://themegallery.robdor.com][theme gallery]] from [[https://twitter.com/robmerrell][Rob Merrell]].
core: dotspacemacs-themes entries now accept package properties It is now possible to use package properties like :location in dotspacemacs-themes. Added hooks ran at the beginning and end of configuration-layer/sync: - configuration-layer-pre-sync-hook - configuration-layer-post-sync-hook configuration-layer-pre-sync-hook is used to hook the new function spacemacs//add-theme-packages-to-additional-packages. This new function updates dotspacemacs--additional-theme-packages variables. Update documentation to mention the new feature.
2017-02-02 03:59:03 +00:00
*** Notes
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
- You don't need to explicitly list in a layer the theme packages you are
core: dotspacemacs-themes entries now accept package properties It is now possible to use package properties like :location in dotspacemacs-themes. Added hooks ran at the beginning and end of configuration-layer/sync: - configuration-layer-pre-sync-hook - configuration-layer-post-sync-hook configuration-layer-pre-sync-hook is used to hook the new function spacemacs//add-theme-packages-to-additional-packages. This new function updates dotspacemacs--additional-theme-packages variables. Update documentation to mention the new feature.
2017-02-02 03:59:03 +00:00
defining in =dotspacemacs-themes=, Spacemacs is smart enough to remove those
packages from the list of orphans.
- Due to the inner working of themes in Emacs, switching theme during the same
session may have some weird side effects. Although these side effects should
be pretty rare.
- In the terminal version of Emacs, color themes will not render correctly as
colors are rendered by the terminal and not by emacs. You will probably have
to change your terminal color palette. More explanations can be found on
[[https://github.com/sellout/emacs-color-theme-solarized#important-note-for-terminal-users][emacs-color-theme-solarized webpage]].
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
** Font
doc: Be consistent with ref to Spacemacs Use of =Spacemacs= vs Spacemacs is inconsistent. This picks Spacemacs as a convention
2015-10-12 23:12:09 +00:00
The default font used by Spacemacs is [[https://github.com/adobe-fonts/source-code-pro][Source Code Pro]] by Adobe. It is
improve font documentation - make it clear that setting dotspacemacs-default-font has no effect in terminal - make it clear that it's user responsibility to install Source Code Pro font
2016-06-30 06:53:32 +00:00
recommended to install it on your system if you wish to use it.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
To change the default font set the variable =dotspacemacs-default-font= in your
improve font documentation - make it clear that setting dotspacemacs-default-font has no effect in terminal - make it clear that it's user responsibility to install Source Code Pro font
2016-06-30 06:53:32 +00:00
=.spacemacs= file. By default its value is:
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(setq-default dotspacemacs-default-font '("Source Code Pro"
Update core-dotspacemacs.el default font size 0ffdb353f9db507320495d19f71759ec819d267a changed the default config template to use a point size instead of a pixel size. Change the defvar declaration as well. Commit modified by duianto: Updated font size in doc/documentation.org
2019-07-17 15:53:28 +00:00
:size 10.0
Reformat documentation
2018-09-19 03:54:47 +00:00
:weight normal
:width normal))
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Fix doc typo and tweak source code pro doc
2016-07-04 01:56:39 +00:00
If the specified font is not found, the fallback one will be used (depends on
your system). Also note that changing this value has no effect if you are
running Emacs in terminal.
improve font documentation - make it clear that setting dotspacemacs-default-font has no effect in terminal - make it clear that it's user responsibility to install Source Code Pro font
2016-06-30 06:53:32 +00:00
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
The properties should be pretty straightforward, it is possible to set any valid
Change HTTP to HTTPS in docs
2017-05-16 12:18:50 +00:00
property of a [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Low_002dLevel-Font.html][font-spec]]:
Reformat documentation
2018-09-19 03:54:47 +00:00
- =:family= Font family or fontset (a string).
- =:width= Relative character width. This should be one of the symbols:
- ultra-condensed
- extra-condensed
- condensed
- semi-condensed
- normal
- semi-expanded
- expanded
- extra-expanded
- ultra-expanded
- =:height= The height of the font. In the simplest case, this is an integer
in units of 1/10 point.
- =:weight= Font weight- one of the symbols (from densest to faintest):
- ultra-bold
- extra-bold
- bold
- semi-bold
- normal
- semi-light
- light
- extra-light
- ultra-light
- =:slant= Font slant- one of the symbols:
- italic
- oblique
- normal
- reverse-italic
- reverse-oblique
- =:size= The font size- either a non-negative integer that specifies the
pixel size, or a floating-point number that specifies the point size.
- =:adstyle= Additional typographic style information for the font, such as
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
'sans'. The value should be a string or a symbol.
Reformat documentation
2018-09-19 03:54:47 +00:00
- =:registry= The charset registry and encoding of the font, such as
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
'iso8859-1'. The value should be a string or a symbol.
Reformat documentation
2018-09-19 03:54:47 +00:00
- =:script= The script that the font must support (a symbol).
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
** GUI Toggles
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Some graphical UI indicators can be toggled on and off (toggles start with ~t~
and ~T~):
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
|-------------+-------------------------------------------------------------------|
Replace enforce-column layer by a toggle on SPC t 8
2016-03-22 01:18:36 +00:00
| ~SPC t 8~ | highlight any character past the 80th column |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
| ~SPC t f~ | display the fill column (by default the fill column is set to 80) |
| ~SPC t h h~ | toggle highlight of the current line |
| ~SPC t h i~ | toggle highlight indentation levels |
| ~SPC t h c~ | toggle highlight indentation current column |
Move SPC t H to SPC t h s SPC t h is the prefix for toggling highlighting stuff.
2016-10-21 22:46:05 +00:00
| ~SPC t h s~ | toggle syntax highlighting |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
| ~SPC t i~ | toggle indentation guide at point |
| ~SPC t l~ | toggle truncate lines |
| ~SPC t L~ | toggle visual lines |
Make linum toggle local and add a variable for global mode `global-linum-mode` is making line numbers appearing in `*spacemacs*` and `helm` buffers, what is annoying. This change make the linum `SPC t n` toggle buffer-local, and add a customization variable in `.spacemacs` to enable line numbers globally. «Globally» here as to be understood as «in `prog-mode` and `text-mode`».
2015-10-26 17:12:41 +00:00
| ~SPC t n~ | toggle line numbers |
[defaults] Disable line numbers with `SPC t n n` Toggles are great and all, but the trouble with the various toggles for line numbers is that they force you to remember and think about the fact that there are variant forms of line numbers. To beginners or forgetful people the various combinations of behavior can be unintuitive here (e.g. toggling off relative line numbers does nothing if you are actual in visual line numbers mode). Though it doesn't fit exactly into the normal stuff we have for toggles, due to the complexity of this situation I think it is good to just have a way to say "line numbers be gone!" Wasn't sure what keybinding to use, so used a double-tap mnemonic. If this PR gets rejected, there are a couple minor fixes that should probably be pulled out and submitted separately.
2021-07-29 17:44:53 +00:00
| ~SPC t n n~ | toggle line numbers as configured in .spacemacs |
| ~SPC t n a~ | toggle absolute line numbers |
| ~SPC t n r~ | toggle relative line numbers |
| ~SPC t n v~ | toggle smooth scrolling |
[doc] Add relative and visual line number keys Documented two missing line number key bindings: `SPC t r` toggle relative line numbers `SPC t V` toggle visual line numbers
2019-06-24 11:31:13 +00:00
| ~SPC t V~ | toggle visual line numbers |
Multiple ways to copy a file path
2018-06-02 15:14:42 +00:00
| ~SPC t z~ | toggle 0/1 based column indexing |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
|-------------+------------------------------------------------------------------|
| ~SPC T ~~ | display =~= in the fringe on empty lines |
| ~SPC T F~ | toggle frame fullscreen |
| ~SPC T f~ | toggle display of the fringe |
| ~SPC T m~ | toggle menu bar |
| ~SPC T M~ | toggle frame maximize |
| ~SPC T t~ | toggle tool bar |
Doc: transient-state => transient state
2016-03-21 02:08:49 +00:00
| ~SPC T T~ | toggle frame transparency and enter transparency transient state |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
*Note*: These toggles are all available via the =spacemacs-help= interfaces
(press ~SPC h SPC~ to display the =spacemacs-help= buffer).
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Format docs
2017-12-31 00:39:19 +00:00
*** Global line numbers
Make linum toggle local and add a variable for global mode `global-linum-mode` is making line numbers appearing in `*spacemacs*` and `helm` buffers, what is annoying. This change make the linum `SPC t n` toggle buffer-local, and add a customization variable in `.spacemacs` to enable line numbers globally. «Globally» here as to be understood as «in `prog-mode` and `text-mode`».
2015-10-26 17:12:41 +00:00
Line numbers can be toggled on in all =prog-mode= and =text-mode= buffers by
dsm-line-numbers: support parent modes, fix mode restriction Specifying parent modes (e.g. prog-mode) in :enabled-for-modes and :disabled-for-modes keys in dotspacemacs-line-numbers catches derived modes (e.g. c-mode) as well. Fix bug where an empty :disabled-for-modes and a non-empty :enabled-for-modes enabled line numbers everywhere, instead of only in modes specified in :enabled-for-modes. (see https://github.com/syl20bnr/spacemacs/issues/8482) Add auxiliary function spacemacs/derived-mode-p, similar to derived-mode-p but takes a major-mode as an argument instead of using the current major-mode.
2017-03-09 14:30:44 +00:00
setting the =dotspacemacs-line-numbers= variable in your =~/.spacemacs= to =t=.
Make linum toggle local and add a variable for global mode `global-linum-mode` is making line numbers appearing in `*spacemacs*` and `helm` buffers, what is annoying. This change make the linum `SPC t n` toggle buffer-local, and add a customization variable in `.spacemacs` to enable line numbers globally. «Globally» here as to be understood as «in `prog-mode` and `text-mode`».
2015-10-26 17:12:41 +00:00
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(setq-default dotspacemacs-line-numbers t)
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+END_SRC
Make linum toggle local and add a variable for global mode `global-linum-mode` is making line numbers appearing in `*spacemacs*` and `helm` buffers, what is annoying. This change make the linum `SPC t n` toggle buffer-local, and add a customization variable in `.spacemacs` to enable line numbers globally. «Globally» here as to be understood as «in `prog-mode` and `text-mode`».
2015-10-26 17:12:41 +00:00
Introduce 'relative for global-line-numbers Allow to use 'relative as value for the dotspacemacs-global-line-numbers setting. This enable relative global line numbers as it is a common usage.
2015-11-02 18:42:17 +00:00
If it is set to =relative=, line numbers are show in a relative way:
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(setq-default dotspacemacs-line-numbers 'relative)
Introduce 'relative for global-line-numbers Allow to use 'relative as value for the dotspacemacs-global-line-numbers setting. This enable relative global line numbers as it is a common usage.
2015-11-02 18:42:17 +00:00
#+END_SRC
Add support for visual line numbers Emacs 26 added built-in support for line numbers, relative line numbers, and visual line numbers. Spacemacs supports only absolute and relative, but there is no way to access the visual mode. It's hard to get around this, since Spacemacs abstracts line numbers to a reasonably high degree. Arguably, `visual` is much more useful than `relative` as a display type. Visual line numbers are like relative line numbers, but only lines that are actually showing are counted. This means: 1. Hidden lines are not counted. If a large amount of text is folded, the line numbers won't jump from "10" to "546". This is particularly useful in buffers like `magit-status`, where a large amount of information is folded by default. 2. Lines that are wrapped are counted as multiple lines, since they're being displayed as multiple lines in the editor. Each visual line will be numbered - unlike `relative`, where the entire thing is numbered... Once. With standard relative line numbers, you can't actually navigate using the line numbers in the sidebar as soon as folded or wrapped lines are introduced. Since this is one of the main use cases for relative line numbers, this is a big problem. Visual mode fixes that problem. Every line that's being displayed is labelled. Numbers always correspond to the actual number of lines you'd need to navigate to reach that line. This commit extends Spacemacs' line number interface to provide visual line number support.
2019-06-17 22:32:37 +00:00
If it is set to =visual=, line numbers are shown in a relative way, but wrapped
lines will be treated as multiple lines:
#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-line-numbers 'visual)
#+END_SRC
line numbers: finer configuration of line numbers activation
2016-11-04 18:33:40 +00:00
=dotspacemacs-line-numbers= can also be set to a property list for finer control
over line numbers activation.
Available properties:
Add support for visual line numbers Emacs 26 added built-in support for line numbers, relative line numbers, and visual line numbers. Spacemacs supports only absolute and relative, but there is no way to access the visual mode. It's hard to get around this, since Spacemacs abstracts line numbers to a reasonably high degree. Arguably, `visual` is much more useful than `relative` as a display type. Visual line numbers are like relative line numbers, but only lines that are actually showing are counted. This means: 1. Hidden lines are not counted. If a large amount of text is folded, the line numbers won't jump from "10" to "546". This is particularly useful in buffers like `magit-status`, where a large amount of information is folded by default. 2. Lines that are wrapped are counted as multiple lines, since they're being displayed as multiple lines in the editor. Each visual line will be numbered - unlike `relative`, where the entire thing is numbered... Once. With standard relative line numbers, you can't actually navigate using the line numbers in the sidebar as soon as folded or wrapped lines are introduced. Since this is one of the main use cases for relative line numbers, this is a big problem. Visual mode fixes that problem. Every line that's being displayed is labelled. Numbers always correspond to the actual number of lines you'd need to navigate to reach that line. This commit extends Spacemacs' line number interface to provide visual line number support.
2019-06-17 22:32:37 +00:00
| Property | Description |
|-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| =:disabled-for-modes= | list of major modes where line numbering is inhibited |
| =:enabled-for-modes= | disable for all major modes except those listed. Takes precedence over =:disabled-for-modes= |
| =:relative= | if non-nil, line numbers are relative to the position of the cursor |
| =:visual= | if non-nil, line numbers are relative to the position of the cursor, but lines are separated by visual state - a wrapped line, for example, will be treated as more than one line. When set to t, this option takes precedence over =:relative= |
| =:size-limit-kb= | size limit in kilobytes after which line numbers are not activated |
line numbers: finer configuration of line numbers activation
2016-11-04 18:33:40 +00:00
Add support for native line numbers in Emacs 26 Emacs 26.1 will introduce a new native line numbers feature: "display-line-numbers". It includes relative line numbers, is faster than current linum-mode, and doesn't use the margin area (it has its own area). So yeah, we want to use the new feature when possible. No changes are required on the user side, except for Emacs 26 users are recommended to remove nlinum layer from their configuration (if they have enabled it). With this change: - Emacs 26: - uses display-line-numbers by default. - linum and linum-relative packages are excluded. - Emacs 25: - does NOT use display-line-numbers. - continues to use linum and linum-relative. - nlinum layer: - can still be used as before in Emacs 25. - is NOT recommended in Emacs 26, but can be used. - when enabled, excludes display-line-numbers. Also contains some bug fixes: Fixes a bug where setting `dostpacemacs-line-numbers` to `t` or `relative` enabled line numbers in every buffer, instead of only in buffers that derive from prog-mode and text-mode. Likewise fixes a bug where specifying `:enabled-for-modes nil` (or not specifying `:enabled-for-modes` at all) in `dotspacemacs-line-numbers` settings meant "enable in all modes" instead of "enable in modes derived from prog-mode or text-mode". Because of this change, also adds a way for users to enable line numbers in *all* buffers. Removes check for special buffer. All our current checks should be enough to enable line numbers only where it makes sense. Disabling in all special buffers is not necessary.
2018-05-10 17:10:31 +00:00
Note that if =:enabled-for-modes= is =nil= or not specified, then the default is
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
to enable line numbers in any =prog-mode= and =text-mode= that wasn't explicitly
Add support for native line numbers in Emacs 26 Emacs 26.1 will introduce a new native line numbers feature: "display-line-numbers". It includes relative line numbers, is faster than current linum-mode, and doesn't use the margin area (it has its own area). So yeah, we want to use the new feature when possible. No changes are required on the user side, except for Emacs 26 users are recommended to remove nlinum layer from their configuration (if they have enabled it). With this change: - Emacs 26: - uses display-line-numbers by default. - linum and linum-relative packages are excluded. - Emacs 25: - does NOT use display-line-numbers. - continues to use linum and linum-relative. - nlinum layer: - can still be used as before in Emacs 25. - is NOT recommended in Emacs 26, but can be used. - when enabled, excludes display-line-numbers. Also contains some bug fixes: Fixes a bug where setting `dostpacemacs-line-numbers` to `t` or `relative` enabled line numbers in every buffer, instead of only in buffers that derive from prog-mode and text-mode. Likewise fixes a bug where specifying `:enabled-for-modes nil` (or not specifying `:enabled-for-modes` at all) in `dotspacemacs-line-numbers` settings meant "enable in all modes" instead of "enable in modes derived from prog-mode or text-mode". Because of this change, also adds a way for users to enable line numbers in *all* buffers. Removes check for special buffer. All our current checks should be enough to enable line numbers only where it makes sense. Disabling in all special buffers is not necessary.
2018-05-10 17:10:31 +00:00
disabled via =:disabled-for-modes=. To enable line numbers in a major mode that
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
doesn't derive from =prog-mode= or =text-mode=, you must specify it directly in
Add support for native line numbers in Emacs 26 Emacs 26.1 will introduce a new native line numbers feature: "display-line-numbers". It includes relative line numbers, is faster than current linum-mode, and doesn't use the margin area (it has its own area). So yeah, we want to use the new feature when possible. No changes are required on the user side, except for Emacs 26 users are recommended to remove nlinum layer from their configuration (if they have enabled it). With this change: - Emacs 26: - uses display-line-numbers by default. - linum and linum-relative packages are excluded. - Emacs 25: - does NOT use display-line-numbers. - continues to use linum and linum-relative. - nlinum layer: - can still be used as before in Emacs 25. - is NOT recommended in Emacs 26, but can be used. - when enabled, excludes display-line-numbers. Also contains some bug fixes: Fixes a bug where setting `dostpacemacs-line-numbers` to `t` or `relative` enabled line numbers in every buffer, instead of only in buffers that derive from prog-mode and text-mode. Likewise fixes a bug where specifying `:enabled-for-modes nil` (or not specifying `:enabled-for-modes` at all) in `dotspacemacs-line-numbers` settings meant "enable in all modes" instead of "enable in modes derived from prog-mode or text-mode". Because of this change, also adds a way for users to enable line numbers in *all* buffers. Removes check for special buffer. All our current checks should be enough to enable line numbers only where it makes sense. Disabling in all special buffers is not necessary.
2018-05-10 17:10:31 +00:00
=:enabled-for-modes=. To enable line numbers even in non-prog-mode and
non-text-mode buffers, set =:enabled-for-modes= to =all=.
dsm-line-numbers: support parent modes, fix mode restriction Specifying parent modes (e.g. prog-mode) in :enabled-for-modes and :disabled-for-modes keys in dotspacemacs-line-numbers catches derived modes (e.g. c-mode) as well. Fix bug where an empty :disabled-for-modes and a non-empty :enabled-for-modes enabled line numbers everywhere, instead of only in modes specified in :enabled-for-modes. (see https://github.com/syl20bnr/spacemacs/issues/8482) Add auxiliary function spacemacs/derived-mode-p, similar to derived-mode-p but takes a major-mode as an argument instead of using the current major-mode.
2017-03-09 14:30:44 +00:00
Examples:
line numbers: finer configuration of line numbers activation
2016-11-04 18:33:40 +00:00
Use single * This ain't markdown...
2018-09-06 08:48:18 +00:00
Disable *line numbers* in dired-mode, doc-view-mode, markdown-mode, org-mode,
line numbers: finer configuration of line numbers activation
2016-11-04 18:33:40 +00:00
pdf-view-mode, text-mode as well as buffers over 1Mb:
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(setq-default dotspacemacs-line-numbers '(:relative nil
:disabled-for-modes dired-mode
doc-view-mode
markdown-mode
org-mode
pdf-view-mode
text-mode
:size-limit-kb 1000))
line numbers: finer configuration of line numbers activation
2016-11-04 18:33:40 +00:00
#+END_SRC
Use single * This ain't markdown...
2018-09-06 08:48:18 +00:00
Enable *relative line numbers* only in c-mode and c++ mode with a size limit of =dotspacemacs-large-file-size=:
line numbers: finer configuration of line numbers activation
2016-11-04 18:33:40 +00:00
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(setq-default dotspacemacs-line-numbers '(:relative t
:enabled-for-modes c-mode
c++-mode
:size-limit-kb (* dotspacemacs-large-file-size 1000))
line numbers: finer configuration of line numbers activation
2016-11-04 18:33:40 +00:00
#+END_SRC
Use single * This ain't markdown...
2018-09-06 08:48:18 +00:00
Enable *line numbers* everywhere, except for buffers over 1Mb:
dsm-line-numbers: support parent modes, fix mode restriction Specifying parent modes (e.g. prog-mode) in :enabled-for-modes and :disabled-for-modes keys in dotspacemacs-line-numbers catches derived modes (e.g. c-mode) as well. Fix bug where an empty :disabled-for-modes and a non-empty :enabled-for-modes enabled line numbers everywhere, instead of only in modes specified in :enabled-for-modes. (see https://github.com/syl20bnr/spacemacs/issues/8482) Add auxiliary function spacemacs/derived-mode-p, similar to derived-mode-p but takes a major-mode as an argument instead of using the current major-mode.
2017-03-09 14:30:44 +00:00
#+BEGIN_SRC emacs-lisp
fix spelling of variable in documentation dotspacemacs-lines-numbers -> dotspacemacs-line-numbers
2017-09-20 20:07:12 +00:00
(setq-default dotspacemacs-line-numbers '(:relative nil
dsm-line-numbers: support parent modes, fix mode restriction Specifying parent modes (e.g. prog-mode) in :enabled-for-modes and :disabled-for-modes keys in dotspacemacs-line-numbers catches derived modes (e.g. c-mode) as well. Fix bug where an empty :disabled-for-modes and a non-empty :enabled-for-modes enabled line numbers everywhere, instead of only in modes specified in :enabled-for-modes. (see https://github.com/syl20bnr/spacemacs/issues/8482) Add auxiliary function spacemacs/derived-mode-p, similar to derived-mode-p but takes a major-mode as an argument instead of using the current major-mode.
2017-03-09 14:30:44 +00:00
:size-limit-kb 1000))
#+END_SRC
Use single * This ain't markdown...
2018-09-06 08:48:18 +00:00
Enable *line numbers* only in programming modes, except for c-mode and c++ mode:
dsm-line-numbers: support parent modes, fix mode restriction Specifying parent modes (e.g. prog-mode) in :enabled-for-modes and :disabled-for-modes keys in dotspacemacs-line-numbers catches derived modes (e.g. c-mode) as well. Fix bug where an empty :disabled-for-modes and a non-empty :enabled-for-modes enabled line numbers everywhere, instead of only in modes specified in :enabled-for-modes. (see https://github.com/syl20bnr/spacemacs/issues/8482) Add auxiliary function spacemacs/derived-mode-p, similar to derived-mode-p but takes a major-mode as an argument instead of using the current major-mode.
2017-03-09 14:30:44 +00:00
#+BEGIN_SRC emacs-lisp
fix spelling of variable in documentation dotspacemacs-lines-numbers -> dotspacemacs-line-numbers
2017-09-20 20:07:12 +00:00
(setq-default dotspacemacs-line-numbers '(:relative nil
dsm-line-numbers: support parent modes, fix mode restriction Specifying parent modes (e.g. prog-mode) in :enabled-for-modes and :disabled-for-modes keys in dotspacemacs-line-numbers catches derived modes (e.g. c-mode) as well. Fix bug where an empty :disabled-for-modes and a non-empty :enabled-for-modes enabled line numbers everywhere, instead of only in modes specified in :enabled-for-modes. (see https://github.com/syl20bnr/spacemacs/issues/8482) Add auxiliary function spacemacs/derived-mode-p, similar to derived-mode-p but takes a major-mode as an argument instead of using the current major-mode.
2017-03-09 14:30:44 +00:00
:enabled-for-modes prog-mode
:disabled-for-modes c-mode c++-mode
:size-limit-kb (* dotspacemacs-large-file-size 1000))
#+END_SRC
Use single * This ain't markdown...
2018-09-06 08:48:18 +00:00
Enable *line numbers* everywhere, even in non-prog-mode and non-text-mode buffers:
Add support for native line numbers in Emacs 26 Emacs 26.1 will introduce a new native line numbers feature: "display-line-numbers". It includes relative line numbers, is faster than current linum-mode, and doesn't use the margin area (it has its own area). So yeah, we want to use the new feature when possible. No changes are required on the user side, except for Emacs 26 users are recommended to remove nlinum layer from their configuration (if they have enabled it). With this change: - Emacs 26: - uses display-line-numbers by default. - linum and linum-relative packages are excluded. - Emacs 25: - does NOT use display-line-numbers. - continues to use linum and linum-relative. - nlinum layer: - can still be used as before in Emacs 25. - is NOT recommended in Emacs 26, but can be used. - when enabled, excludes display-line-numbers. Also contains some bug fixes: Fixes a bug where setting `dostpacemacs-line-numbers` to `t` or `relative` enabled line numbers in every buffer, instead of only in buffers that derive from prog-mode and text-mode. Likewise fixes a bug where specifying `:enabled-for-modes nil` (or not specifying `:enabled-for-modes` at all) in `dotspacemacs-line-numbers` settings meant "enable in all modes" instead of "enable in modes derived from prog-mode or text-mode". Because of this change, also adds a way for users to enable line numbers in *all* buffers. Removes check for special buffer. All our current checks should be enough to enable line numbers only where it makes sense. Disabling in all special buffers is not necessary.
2018-05-10 17:10:31 +00:00
#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-line-numbers '(:enabled-for-modes 'all))
#+END_SRC
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
** Mode-line
core: add support for mode-line themes New layer variable `dotspacemacs-mode-line-themes`: Set the theme for the Spaceline. Supported themes are `spacemacs', `all-the-icons', `custom', `vim-powerline' and `vanilla'. The first three are spaceline themes. `vanilla' is default Emacs mode-line. `custom' is a user defined themes, refer to the DOCUMENTATION.org for more info on how to create your own spaceline theme." See DOCUMENTATION.org changes for more info. This commit adds support for `spaceline-all-the-icons` package.
2018-01-12 04:53:44 +00:00
*** Mode-line themes
Spacemacs supports different mode-line themes. The mode-line theme is set in the
dotfile with the variable =dotspacemacs-mode-line-theme=.
Currently supported themes are:
- spaceline themes: =spacemacs=, =all-the-icons=, =custom=
- a powerline theme: =vim-powerline=
- no theme at all: =vanilla=
The default theme is =spacemacs= and this theme is described in more detailed in
the next section.
doc: further tweaks of mode-line section
2018-01-12 05:06:50 +00:00
=all-the-icons= is the theme defined in the package [[https://github.com/domtronn/spaceline-all-the-icons.el][spaceline-all-the-icons]].
core: add support for mode-line themes New layer variable `dotspacemacs-mode-line-themes`: Set the theme for the Spaceline. Supported themes are `spacemacs', `all-the-icons', `custom', `vim-powerline' and `vanilla'. The first three are spaceline themes. `vanilla' is default Emacs mode-line. `custom' is a user defined themes, refer to the DOCUMENTATION.org for more info on how to create your own spaceline theme." See DOCUMENTATION.org changes for more info. This commit adds support for `spaceline-all-the-icons` package.
2018-01-12 04:53:44 +00:00
=custom= is a user custom spaceline theme, see the guide in the following section.
=vim-powerline= is for the Vim users who are nostalgic of the good old Vim
powerline.
=vanilla= is the stock mode-line that comes with Emacs.
Add properties for mode-line theme, remove powerline-scale Since we have now a variable for the mode-line theme, it makes sense to move the scaling of the mode-line to this variable. Thus the property =:powerline-scale= of variable dotspacemacs-default-font has been removed and it is replace by the property =:separator-scale= used in the variable =dotspacemacs-mode-line-theme=. This commit also adds a the property =:sperator= for the variable =dotspacemacs-mode-line-theme= which allows to set the separator type. Example of the final result: dotspacemacs-mode-line-theme '(all-the-icons :separator cup :separator-scale 1.5) Documentation has been updated to reflect the changes.
2018-01-17 03:59:29 +00:00
*** Separators
For =spacemacs=, =all-the-icons= and =custom= themes you can specify the type
of separator you want with the property =:separator=.
#+BEGIN_SRC emacs-lisp
Update DOCUMENTATION.org
2019-09-17 19:38:53 +00:00
(setq dotspacemacs-mode-line-theme '(all-the-icons :separator slant))
Add properties for mode-line theme, remove powerline-scale Since we have now a variable for the mode-line theme, it makes sense to move the scaling of the mode-line to this variable. Thus the property =:powerline-scale= of variable dotspacemacs-default-font has been removed and it is replace by the property =:separator-scale= used in the variable =dotspacemacs-mode-line-theme=. This commit also adds a the property =:sperator= for the variable =dotspacemacs-mode-line-theme= which allows to set the separator type. Example of the final result: dotspacemacs-mode-line-theme '(all-the-icons :separator cup :separator-scale 1.5) Documentation has been updated to reflect the changes.
2018-01-17 03:59:29 +00:00
#+END_SRC
Supported separators and preview:
| Separator | Spacemacs | All-the-icons | Screenshot |
|--------------+-----------+---------------+-----------------------------------|
doc fmt
2018-01-27 14:08:07 +00:00
| =alternate= | X | | [[file:img/powerline-alternate.png]] |
| =arrow= | X | X | [[file:img/powerline-arrow.png]] |
| =arrow-fade= | X | | [[file:img/powerline-arrow-fade.png]] |
| =bar= | X | | [[file:img/powerline-bar.png]] |
| =box= | X | | [[file:img/powerline-box.png]] |
| =brace= | X | | [[file:img/powerline-brace.png]] |
| =butt= | X | | [[file:img/powerline-butt.png]] |
| =chamfer= | X | | [[file:img/powerline-chamfer.png]] |
| =contour= | X | | [[file:img/powerline-contour.png]] |
| =cup= | | X | |
| =curve= | X | | [[file:img/powerline-curve.png]] |
| =rounded= | X | | [[file:img/powerline-rounded.png]] |
| =roundstub= | X | | [[file:img/powerline-roundstub.png]] |
| =slant= | X | X | [[file:img/powerline-slant.png]] |
| =wave= | X | X | [[file:img/powerline-wave.png]] |
| =zigzag= | X | | [[file:img/powerline-zigzag.png]] |
| =nil= | X | | [[file:img/powerline-nil.png]] |
| =none= | | X | |
Add properties for mode-line theme, remove powerline-scale Since we have now a variable for the mode-line theme, it makes sense to move the scaling of the mode-line to this variable. Thus the property =:powerline-scale= of variable dotspacemacs-default-font has been removed and it is replace by the property =:separator-scale= used in the variable =dotspacemacs-mode-line-theme=. This commit also adds a the property =:sperator= for the variable =dotspacemacs-mode-line-theme= which allows to set the separator type. Example of the final result: dotspacemacs-mode-line-theme '(all-the-icons :separator cup :separator-scale 1.5) Documentation has been updated to reflect the changes.
2018-01-17 03:59:29 +00:00
A last special separator is supported, it is =utf-8= which uses actual font
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
glyphs so it can be rendered in a terminal. You'll need a font patched for the
Add properties for mode-line theme, remove powerline-scale Since we have now a variable for the mode-line theme, it makes sense to move the scaling of the mode-line to this variable. Thus the property =:powerline-scale= of variable dotspacemacs-default-font has been removed and it is replace by the property =:separator-scale= used in the variable =dotspacemacs-mode-line-theme=. This commit also adds a the property =:sperator= for the variable =dotspacemacs-mode-line-theme= which allows to set the separator type. Example of the final result: dotspacemacs-mode-line-theme '(all-the-icons :separator cup :separator-scale 1.5) Documentation has been updated to reflect the changes.
2018-01-17 03:59:29 +00:00
Vim powerline to be able to use it. The default font used by Spacemacs =Source
Code Pro= already contains the glyphs.
*** Separator scale
For =spacemacs=, =all-the-icons= and =custom= themes you can specify the size of
the separator with the property =:separator-scale=. It allows to avoid crappy
rendering of the separators like on the following screenshot.
[[file:img/crappy-powerline-separators.png]]
/Ugly separators/
Example:
#+BEGIN_SRC elisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(setq dotspacemacs-mode-line-theme '(all-the-icons :separator-scale 1.5))
Add properties for mode-line theme, remove powerline-scale Since we have now a variable for the mode-line theme, it makes sense to move the scaling of the mode-line to this variable. Thus the property =:powerline-scale= of variable dotspacemacs-default-font has been removed and it is replace by the property =:separator-scale= used in the variable =dotspacemacs-mode-line-theme=. This commit also adds a the property =:sperator= for the variable =dotspacemacs-mode-line-theme= which allows to set the separator type. Example of the final result: dotspacemacs-mode-line-theme '(all-the-icons :separator cup :separator-scale 1.5) Documentation has been updated to reflect the changes.
2018-01-17 03:59:29 +00:00
#+END_SRC
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
Note that this setting won't work correctly when the separator is =utf-8=, if
Add properties for mode-line theme, remove powerline-scale Since we have now a variable for the mode-line theme, it makes sense to move the scaling of the mode-line to this variable. Thus the property =:powerline-scale= of variable dotspacemacs-default-font has been removed and it is replace by the property =:separator-scale= used in the variable =dotspacemacs-mode-line-theme=. This commit also adds a the property =:sperator= for the variable =dotspacemacs-mode-line-theme= which allows to set the separator type. Example of the final result: dotspacemacs-mode-line-theme '(all-the-icons :separator cup :separator-scale 1.5) Documentation has been updated to reflect the changes.
2018-01-17 03:59:29 +00:00
you use this separator then it is recommended to set =:separator-scale= to =1.0=.
core: add support for mode-line themes New layer variable `dotspacemacs-mode-line-themes`: Set the theme for the Spaceline. Supported themes are `spacemacs', `all-the-icons', `custom', `vim-powerline' and `vanilla'. The first three are spaceline themes. `vanilla' is default Emacs mode-line. `custom' is a user defined themes, refer to the DOCUMENTATION.org for more info on how to create your own spaceline theme." See DOCUMENTATION.org changes for more info. This commit adds support for `spaceline-all-the-icons` package.
2018-01-12 04:53:44 +00:00
*** Spacemacs mode-line theme
Add properties for mode-line theme, remove powerline-scale Since we have now a variable for the mode-line theme, it makes sense to move the scaling of the mode-line to this variable. Thus the property =:powerline-scale= of variable dotspacemacs-default-font has been removed and it is replace by the property =:separator-scale= used in the variable =dotspacemacs-mode-line-theme=. This commit also adds a the property =:sperator= for the variable =dotspacemacs-mode-line-theme= which allows to set the separator type. Example of the final result: dotspacemacs-mode-line-theme '(all-the-icons :separator cup :separator-scale 1.5) Documentation has been updated to reflect the changes.
2018-01-17 03:59:29 +00:00
This theme is a heavily customized [[https://github.com/milkypostman/powerline][powerline]] using [[https://github.com/TheBB/spaceline][spaceline]].
It has the following capabilities among others:
Reformat documentation
2018-09-19 03:54:47 +00:00
- show the window number
- color code for current state
- show the number of search occurrences via anzu
- toggle flycheck info
- toggle battery info
- toggle minor mode lighters
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Reminder of the color codes for the states:
Update modeline documentation [ci skip]
2015-08-26 13:02:33 +00:00
| Evil State | Color |
|--------------------+-----------|
| Normal | Orange |
| Insert | Green |
| Visual | Grey |
| Emacs | Blue |
| Motion | Purple |
| Replace | Chocolate |
| Lisp | Pink |
| Iedit/Iedit-Insert | Red |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Some elements can be dynamically toggled:
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
|-------------+-----------------------------------------------------------------|
| ~SPC t m b~ | toggle the battery status |
| ~SPC t m c~ | toggle the =org= task clock (available in =org= layer) |
| ~SPC t m m~ | toggle the minor mode lighters |
powerline: modify some segment toggle key bindings tmj -> tmM for major mode tmg -> tmv for version control tmv -> tmV for new version
2015-07-27 03:04:06 +00:00
| ~SPC t m M~ | toggle the major mode |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
| ~SPC t m n~ | toggle the cat! (if =colors= layer is declared in your dotfile) |
| ~SPC t m p~ | toggle the point character position |
Add toggle for spaceline responsivness under SPC t m r
2018-01-17 20:23:37 +00:00
| ~SPC t m r~ | toggle responsivness of the mode-line |
Move symon to spacemacs-modeline layer
2017-04-12 03:36:13 +00:00
| ~SPC t m s~ | toggle system monitor (displayed in the minibuffer) |
Inverse SPC t m t and SPC t m T Toggling the time is a segment so it is more consistent with the rest of the lowercase keys. Toggling the whole mode-line feels better on a capital letter.
2016-10-21 22:40:38 +00:00
| ~SPC t m t~ | toggle the time |
| ~SPC t m T~ | toggle the mode line itself |
powerline: modify some segment toggle key bindings tmj -> tmM for major mode tmg -> tmv for version control tmv -> tmV for new version
2015-07-27 03:04:06 +00:00
| ~SPC t m v~ | toggle the version control info |
| ~SPC t m V~ | toggle the new version lighter |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
core: add support for mode-line themes New layer variable `dotspacemacs-mode-line-themes`: Set the theme for the Spaceline. Supported themes are `spacemacs', `all-the-icons', `custom', `vim-powerline' and `vanilla'. The first three are spaceline themes. `vanilla' is default Emacs mode-line. `custom' is a user defined themes, refer to the DOCUMENTATION.org for more info on how to create your own spaceline theme." See DOCUMENTATION.org changes for more info. This commit adds support for `spaceline-all-the-icons` package.
2018-01-12 04:53:44 +00:00
**** Flycheck integration
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
When [[https://github.com/flycheck/flycheck][Flycheck]] minor mode is enabled, a new element appears showing the number of
errors, warnings and info.
[[file:img/powerline-wave.png]]
space-doc: disable line numbers and resized images Resize images to 600 pixel width (exclude README.org for now) Disable line numbers.
2016-06-10 19:50:45 +00:00
/Flycheck integration in mode-line/
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
core: add support for mode-line themes New layer variable `dotspacemacs-mode-line-themes`: Set the theme for the Spaceline. Supported themes are `spacemacs', `all-the-icons', `custom', `vim-powerline' and `vanilla'. The first three are spaceline themes. `vanilla' is default Emacs mode-line. `custom' is a user defined themes, refer to the DOCUMENTATION.org for more info on how to create your own spaceline theme." See DOCUMENTATION.org changes for more info. This commit adds support for `spaceline-all-the-icons` package.
2018-01-12 04:53:44 +00:00
**** Anzu integration
Fix some typos (#14832)
2021-06-06 23:43:22 +00:00
[[https://github.com/syohex/emacs-anzu][Anzu]] shows the number of occurrences when performing a search. Spacemacs
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
integrates the Anzu status nicely by displaying it temporarily when ~n~ or ~N~
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
are being pressed. See the =5/6= segment on the screenshot below.
[[file:img/powerline-anzu.png]]
space-doc: disable line numbers and resized images Resize images to 600 pixel width (exclude README.org for now) Disable line numbers.
2016-06-10 19:50:45 +00:00
/Anzu integration in mode-line/
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
core: add support for mode-line themes New layer variable `dotspacemacs-mode-line-themes`: Set the theme for the Spaceline. Supported themes are `spacemacs', `all-the-icons', `custom', `vim-powerline' and `vanilla'. The first three are spaceline themes. `vanilla' is default Emacs mode-line. `custom' is a user defined themes, refer to the DOCUMENTATION.org for more info on how to create your own spaceline theme." See DOCUMENTATION.org changes for more info. This commit adds support for `spaceline-all-the-icons` package.
2018-01-12 04:53:44 +00:00
**** Battery status integration
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
[[https://github.com/lunaryorn/fancy-battery.el][fancy-battery]] displays the percentage of total charge of the battery as well as
the time remaining to charge or discharge completely the battery.
A color code is used for the battery status:
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
| Battery State | Color |
|---------------+--------|
| Charging | Green |
| Discharging | Orange |
| Critical | Red |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Fix capitalization of changes Update capitalization as per feedback.
2017-12-20 00:14:29 +00:00
*Note*: These colors may vary depending on your theme.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
doc: further tweaks of mode-line section
2018-01-12 05:06:50 +00:00
*** All-the-Icons theme
If you want to use this theme you need to make sure to install the required
fonts from the package repository, see [[https://github.com/domtronn/all-the-icons.el/tree/master/fonts][all-the-icons fonts directory]].
*** Custom spaceline theme
You can create your own Spaceline theme by setting the variable
=dotspacemacs-mode-line-theme= to =custom= and define a function called
=spaceline-custom-theme= in your =dotspacemacs/user-init= function of your
[docs] Fix spelling, Reorder configuration functions To logical order
2018-10-14 21:48:17 +00:00
dotfile. This function must accept a variadic number of arguments which are
doc: further tweaks of mode-line section
2018-01-12 05:06:50 +00:00
additional segments added by Spacemacs (like a segment to notify about available
updates etc...).
Example:
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(defun spaceline-custom-theme (&rest additional-segments)
"My custom spaceline theme."
(spaceline-compile
`(major-mode (minor-modes :when active) buffer-id)
`((line-column :separator " | " :priority 3)
,@additional-segments))
(setq-default mode-line-format '("%e" (:eval (spaceline-ml-main)))))
doc: further tweaks of mode-line section
2018-01-12 05:06:50 +00:00
#+END_SRC
Restart Emacs and enjoy your very own mode-line!
*** Minor Modes
Change HTTP to HTTPS in docs
2017-05-16 12:18:50 +00:00
Spacemacs uses [[https://www.emacswiki.org/emacs/DiminishedModes][diminish]] mode to reduce the size of minor mode indicators:
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
The minor mode area can be toggled on and off with ~SPC t m m~
Unicode symbols are displayed by default. Setting the variable
=dotspacemacs-mode-line-unicode-symbols= to =nil= in your =~/.spacemacs= will
display ASCII characters instead (may be useful in terminal if you cannot set an
appropriate font).
The letters displayed in the mode-line correspond to the key bindings used to
toggle them.
Fix some typos (#14832)
2021-06-06 23:43:22 +00:00
Some toggles have two flavors: local and global. The global version of the toggle
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
can be reached using the =control= key.
DOCUMENTATION.org: Fix typos
2018-11-10 19:51:11 +00:00
Additionally all globally available toggles have a circled unicode symbols like
core: add support for major mode specific toggles Modify macro spacemacs|add-toggle to create additional sets of functions for each supported modes when the toggle is major mode specific. A toggle is major mode specific when it is bound to keys using the keyword :evil-leader-for-mode Updare documentation to add a section on toggles in the Spacemacs concepts.
2018-01-04 05:03:22 +00:00
=ⓟ=. Toggles specific to a major mode under the ~SPC m T~ prefix have plain
squared symbols like =🅿=.
[doc] add visual line nav keys, startup snippet documentation.org - added visual line navigation (w/w/o) globally keys and unicode/ascii symbol faq.org - updated snippet for enabling visual line navigation globally on startup
2019-10-30 09:00:05 +00:00
| Key binding | Unicode | ASCII | Mode |
|---------------+---------+-------+----------------------------------------------------------------------|
[doc] fix links
2021-07-12 14:28:58 +00:00
| ~SPC t -~ | =⊝= | - | [[https://github.com/emacsmirror/centered-cursor-mode][centered-cursor]] mode |
[doc] add visual line nav keys, startup snippet documentation.org - added visual line navigation (w/w/o) globally keys and unicode/ascii symbol faq.org - updated snippet for enabling visual line navigation globally on startup
2019-10-30 09:00:05 +00:00
| ~SPC t 8~ | =⑧= | 8 | toggle highlight of characters for long lines |
| ~SPC t C-8~ | =⑧= | 8 | global toggle highlight of characters for long lines |
| ~SPC t C--~ | =⊝= | - | global centered cursor |
| ~SPC t a~ | =ⓐ= | a | auto-completion |
| ~SPC t c~ | =ⓒ= | c | camel case motion with subword mode |
| =none= | =ⓔ= | e | [[https://github.com/Somelauw/evil-org-mode][evil-org]] mode |
| ~SPC t E e~ | =Ⓔe= | Ee | emacs editing style (holy mode) |
| ~SPC t E h~ | =Ⓔh= | Eh | hybrid editing style (hybrid mode) |
| ~SPC t f~ | =ⓕ= | f | fill-column-indicator mode |
| ~SPC t F~ | =Ⓕ= | F | auto-fill mode |
| ~SPC t G~ | =Ⓖ= | G | [[http://spacemacs.org/layers/+tags/gtags/README.html][ggtags]] mode |
| ~SPC t g~ | =ⓖ= | g | [[https://github.com/roman/golden-ratio.el][golden-ratio]] mode |
| ~SPC t h i~ | =ⓗi= | hi | toggle highlight indentation levels |
| ~SPC t h c~ | =ⓗc= | hc | toggle highlight indentation current column |
| ~SPC t i~ | =ⓘ= | i | indentation guide |
| ~SPC t C-i~ | =ⓘ= | i | global indentation guide |
| ~SPC t I~ | =Ⓘ= | I | aggressive indent mode |
| ~SPC t K~ | =Ⓚ= | K | which-key mode |
| ~SPC t L~ | =Ⓛ= | L | visual line navigation |
| ~SPC t C-S-l~ | =Ⓛ= | L | visual line navigation globally |
| ~SPC t p~ | =ⓟ= | p | [[https://github.com/Fuco1/smartparens][smartparens]] mode |
| ~SPC t C-p~ | =ⓟ= | p | global smartparens |
| ~SPC t s~ | =ⓢ= | s | syntax checking (flycheck) |
| ~SPC t S~ | =Ⓢ= | S | enabled in [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Bcheckers/spell-checking/README.org][spell checking layer]] (flyspell) |
| ~SPC t w~ | =ⓦ= | w | whitespace mode |
| ~SPC t C-w~ | =ⓦ= | w | global whitespace |
| ~SPC t W~ | =Ⓦ= | W | automatic whitespace cleanup (see =dotspacemacs-whitespace-cleanup=) |
| ~SPC t C-W~ | =Ⓦ= | W | automatic whitespace cleanup globally |
| ~SPC t y~ | =ⓨ= | y | [[https://github.com/capitaomorte/yasnippet][yasnippet]] mode |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Add j and k to transient states It is nicer when user can stay in the "home row" for basic operations like zooming in and out Font Scaling Transient State `k` scale up `j` scale down Frame Transparency Transient State `k` increase transparency `j` decrease transparency Zoom Frame Transient State `k` zoom frame in `j` zoom frame out Added two additional Zoom Frame TS keys: `m` max frame `f` fullscreen
2018-08-25 02:23:13 +00:00
** Frame
*** Title
documentation formatting: Sun May 19 20:32:09 UTC 2019
2019-05-19 20:32:09 +00:00
Default frame title displays name of current process and hostname of system. You
can include more information (like name of current file, name of current project
etc) by setting =dotspacemacs-frame-title-format= variable.
Following format short codes are available:
| Code | Description |
|------+------------------------------------------------------------------------------|
| =%a= | the =abbreviated-file-name=, or =buffer-name= |
| =%t= | =projectile-project-name= |
| =%I= | =invocation-name= |
| =%S= | =system-name= |
| =%U= | contents of $USER |
| =%b= | buffer name |
| =%f= | visited file name |
| =%F= | frame name |
| =%s= | process status |
| =%p= | percent of buffer above top of window, or Top, Bot or All |
| =%P= | percent of buffer above bottom of window, perhaps plus Top, or Bottom or All |
| =%m= | mode name |
| =%n= | Narrow if appropriate |
| =%z= | mnemonics of buffer, terminal, and keyboard coding systems |
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
| =%Z= | like %z, but including the end-of-line format" |
Add j and k to transient states It is nicer when user can stay in the "home row" for basic operations like zooming in and out Font Scaling Transient State `k` scale up `j` scale down Frame Transparency Transient State `k` increase transparency `j` decrease transparency Zoom Frame Transient State `k` zoom frame in `j` zoom frame out Added two additional Zoom Frame TS keys: `m` max frame `f` fullscreen
2018-08-25 02:23:13 +00:00
**** Iconified (tabified) title
documentation formatting: Sun May 19 20:32:09 UTC 2019
2019-05-19 20:32:09 +00:00
If you are using tiling window manager with tab support you may want to display
different title for inactive tabs with =dotspacemacs-icon-title-format=
variable. Short codes are same as for frame title.
Add j and k to transient states It is nicer when user can stay in the "home row" for basic operations like zooming in and out Font Scaling Transient State `k` scale up `j` scale down Frame Transparency Transient State `k` increase transparency `j` decrease transparency Zoom Frame Transient State `k` zoom frame in `j` zoom frame out Added two additional Zoom Frame TS keys: `m` max frame `f` fullscreen
2018-08-25 02:23:13 +00:00
documentation formatting: Sun May 19 20:32:09 UTC 2019
2019-05-19 20:32:09 +00:00
If this variable is set to =nil= (default) its value will be same as
=dotspacemacs-frame-title-format=.
Add j and k to transient states It is nicer when user can stay in the "home row" for basic operations like zooming in and out Font Scaling Transient State `k` scale up `j` scale down Frame Transparency Transient State `k` increase transparency `j` decrease transparency Zoom Frame Transient State `k` zoom frame in `j` zoom frame out Added two additional Zoom Frame TS keys: `m` max frame `f` fullscreen
2018-08-25 02:23:13 +00:00
*** Transparency
The Frame transparency can be toggled with: ~SPC T T~
This also opens the Frame Transparency Transient State.
In the transient state:
| Key binding | Description |
|---------------+--------------------------------|
| ~+~, ~=~, ~k~ | increase transparency |
Add transient state keys _, j, k Thanks sdwolfz for the suggestion to add underscore to the transient states, then the shift key doesn't have to be released if it was held down to press `+`. Added key bindings: Evil numbers: `SPC n _` decrease number under point in the transient state: `j` decrease number under point `k` increase number under point `SPC T T _` decrease transparency `SPC z x _` scale down font `SPC z f _` zoom out frame Update documentation: Zoom frame: `q` quit transient state Evil numbers: `SPC n =` increase number under point `SPC n _` decrease number under point `0..9` add a number prefix argument `q` quit transient state Fixed a typo and made a small rewrite of the tip about using a prefix argument. Added keys to transient states: Font scaling: Added `_` scale down Reordered `k` assignment to match the order in the transient state Frame transparency: Added `_` decrease Reordered `k` assignment to match the order in the transient state Evil numbers: Added `k` increase Added `_` and `j` decrease Zoom frame: Added `_` zoom frame out Reordered `k` assignment to match the order in the transient state Which-key entries for Evil numbers `SPC n`: Group together keys that call the same command: From: + and = To: +,= From: - and _ To: -,_
2019-05-20 17:10:51 +00:00
| ~-~, ~_~, ~j~ | decrease transparency |
Add j and k to transient states It is nicer when user can stay in the "home row" for basic operations like zooming in and out Font Scaling Transient State `k` scale up `j` scale down Frame Transparency Transient State `k` increase transparency `j` decrease transparency Zoom Frame Transient State `k` zoom frame in `j` zoom frame out Added two additional Zoom Frame TS keys: `m` max frame `f` fullscreen
2018-08-25 02:23:13 +00:00
| ~T~ | toggle transparency on and off |
| ~q~ | quit transient state |
Improve support for fancy frame title
2017-04-28 22:44:27 +00:00
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
* Layouts and workspaces
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
Layouts are window configurations with buffer isolation. Each layout can define
several workspaces (think of them as sub-layouts), sharing the same list of
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
buffers as their parent layout.
** Layouts
A layout is a window configuration associated with a list of buffers. The list
of buffers can be an arbitrarily chosen set of buffers. Spacemacs provides
some facilities to create meaningful sets of buffers, for instance the buffers
related to a projectile project.
The name of the current layout appears in the mode-line at the far left (first
element of the mode-line).
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
To create a new layout, type a layout number that does not exist yet.
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
For instance if you have two layouts currently then type ~SPC l 3~ to create a
third layout.
*** The default layout
The =default= layout (the layout created at the startup of Emacs) is not
displayed in the mode-line but it is possible to display it by setting the
variable =dotspacemacs-display-default-layout= to =t=.
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
Its name is "default" by default but it can be changed by setting the variable
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
=dotspacemacs-default-layout-name=.
The =default= layout is special because it has a global scope which means that
all the opened buffers belong to it. So using only the =default= layout feels
like not using layouts at all.
*** Project layouts
A project layout is bound to a projectile project. To create a project layout
use ~SPC p l~.
The name of the layout is the name of the project root directory.
*** Custom Layouts
Custom layouts can be defined using the macro ~spacemacs|define-custom-layout~,
they are accessible via ~SPC l o~.
By convention the name of a custom layout should start with =@=.
Example of custom layout definition for =ERC= buffers:
#+BEGIN_SRC emacs-lisp
(spacemacs|define-custom-layout "@ERC"
:binding "E"
:body
(progn
;; hook to add all ERC buffers to the layout
(defun spacemacs-layouts/add-erc-buffer-to-persp ()
(persp-add-buffer (current-buffer)
(persp-get-by-name
erc-spacemacs-layout-name)))
(add-hook 'erc-mode-hook #'spacemacs-layouts/add-erc-buffer-to-persp)
;; Start ERC
(call-interactively 'erc)))
#+END_SRC
Then use ~SPC l o E~ to start ERC inside its own layout. Any new ERC buffer
will be part of the custom layout.
Some custom layouts that ship with Spacemacs:
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Name | Key binding | Description |
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
|------------+-------------+---------------------------------------------------------------------------------|
| @Spacemacs | ~e~ | Custom perspective containing all buffers of =~/.emacs.d= |
Add custom layout for mu4e buffers This commit adds a custom layout for mu4e related buffers. Four different major modes are used in mu4e buffers based on their purpose, so a function is used to add buffers in these modes to the new layout. This setup is largely based on that of the ERC layers custom layout.
2017-04-29 17:30:07 +00:00
| @Mu4e | ~m~ | Custom perspective containing all mu4e buffers (needs the mu4e layer enabled) |
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
| @ERC | ~E~ | Custom perspective containing all ERC buffers (needs the erc layer enabled) |
| @RCIRC | ~i~ | Custom perspective containing all RCIRC buffers (needs the rcirc layer enabled) |
Add @Slack layout to documented list of default custom layouts This commit adds the custom layout defined in the Slack layer to the list of custom layouts that spacemacs ships with in `doc/DOCUMENTATION.org`
2017-04-29 16:57:51 +00:00
| @Slack | ~s~ | Custom perspective containing all Slack buffers (needs the slack layer enabled) |
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
| @Org | ~o~ | Custom perspective containing all the =org-agenda= buffers |
*** Save/Load layouts into a file
With ~SPC l s~ and ~SPC l L~ you can save and load layouts to/from a file.
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
*Note*: By default, Spacemacs will automatically save the layouts under the name
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
=persp-auto-save=.
Setting the variable =dotspacemacs-auto-resume-layouts= to =t= will
automatically resume the last saved layouts.
*** Layout key bindings
Doc: transient-state => transient state
2016-03-21 02:08:49 +00:00
The key bindings are registered in a transient state. The docstring of the
transient state displays the existing layouts and the currently active
Update layouts and workspaces documentation
2016-03-21 02:00:45 +00:00
layout has square brackets. Pressing a layout number will activate it (or
Doc: transient-state => transient state
2016-03-21 02:08:49 +00:00
create a new one) and exit the transient state. It is possible to just preview a
Update layouts and workspaces documentation
2016-03-21 02:00:45 +00:00
layout with ~Ctrl-<number>~. Pressing ~TAB~ will activate the previously
selected layout.
Press ~?~ to toggle the full help.
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Add 'z' recenter bindings for various transient states By analogy with the "zz", "zb", "zt" vim / evil bindings, this adds an additional key binding "z" for `recenter-top-bottom` to the following transient states which navigate around the buffer in large jumps: - auto-symbol-highlight - error - buffer - vcs - org-babel This allows for repositioning of the buffer for visibility without having to exit the transient state. Minor updates are also made to documentation of other transient states.
2018-10-22 08:09:55 +00:00
|---------------------+------------------------------------------------------------|
| ~SPC l~ | initiate transient state |
| ~?~ | toggle the documentation |
| ~[0..9]~ | switch to nth layout |
| ~[C-0..C-9]~ | switch to nth layout and keep the transient state active |
| ~<tab>~ | switch to the latest layout |
| ~a~ | add a buffer to the current layout |
| ~A~ | add all the buffers from another layout in the current one |
| ~b~ | select a buffer in the current layout |
| ~d~ | delete the current layout and keep its buffers |
| ~D~ | delete the other layouts and keep their buffers |
| ~h~ | go to default layout |
| ~l~ | select/create a layout |
| ~L~ | load layouts from file |
| ~n~ or ~C-l~ | next layout in list |
| ~N~ or ~p~ or ~C-h~ | previous layout in list |
| ~o~ | open a custom layout |
| ~r~ | remove current buffer from layout |
| ~R~ | rename current layout |
| ~s~ | save layouts |
| ~t~ | display a buffer without adding it to the current layout |
| ~w~ | workspaces transient state (needs eyebrowse layer enabled) |
| ~x~ | kill current layout with its buffers |
| ~X~ | kill other layouts with their buffers |
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
Move doc for layout restriction and SPC TAB to DOCUMENTATION.org
2019-08-20 04:54:41 +00:00
*** Behavior of SPC TAB with layouts
By default ~SPC TAB~ which switches to last opened buffer is restricted to the
current layout. If there is only one opened buffer for a given layout then
~SPC TAB~ won't do anything and the following message is displayed in the
minibuffer:
documentation formatting: Fri Aug 23 17:22:19 UTC 2019
2019-08-23 17:22:19 +00:00
#+BEGIN_QUOTE
Last buffer not found.
#+END_QUOTE
Move doc for layout restriction and SPC TAB to DOCUMENTATION.org
2019-08-20 04:54:41 +00:00
To allow ~SPC TAB~ to switch to the last opened buffer from another layout set
this variable =spacemacs-layouts-restrict-spc-tab= to =nil=. For instance in
your used layer list with layer variables:
documentation formatting: Fri Aug 23 17:22:19 UTC 2019
2019-08-23 17:22:19 +00:00
#+BEGIN_EXAMPLE
Move doc for layout restriction and SPC TAB to DOCUMENTATION.org
2019-08-20 04:54:41 +00:00
(spacemacs-layouts :variables spacemacs-layouts-restrict-spc-tab t)
documentation formatting: Fri Aug 23 17:22:19 UTC 2019
2019-08-23 17:22:19 +00:00
#+END_EXAMPLE
Move doc for layout restriction and SPC TAB to DOCUMENTATION.org
2019-08-20 04:54:41 +00:00
*** Restrict a given function to the current layout
You can make any function "layout aware" by adding it to the list
=spacemacs-layouts-restricted-functions=. It is not possible to change this
variable when Emacs is running. You have to define it using layer variables.
If you change this variable then Emacs must be restarted for the change to
take effect.
Default value for this variable is:
documentation formatting: Fri Aug 23 17:22:19 UTC 2019
2019-08-23 17:22:19 +00:00
#+BEGIN_EXAMPLE
Move doc for layout restriction and SPC TAB to DOCUMENTATION.org
2019-08-20 04:54:41 +00:00
'(spacemacs/window-split-double-columns
spacemacs/window-split-triple-columns
spacemacs/window-split-grid)
documentation formatting: Fri Aug 23 17:22:19 UTC 2019
2019-08-23 17:22:19 +00:00
#+END_EXAMPLE
Move doc for layout restriction and SPC TAB to DOCUMENTATION.org
2019-08-20 04:54:41 +00:00
If you want to add the function =my-func= to this list you need to redefine
the complete list using layer variables:
#+BEGIN_EXAMPLE
(spacemacs-layouts :variables
spacemacs-layouts-restricted-functions
'(spacemacs/window-split-double-columns
spacemacs/window-split-triple-columns
spacemacs/window-split-grid
my-func))
#+END_EXAMPLE
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
** Workspaces
Update layouts and workspaces documentation
2016-03-21 02:00:45 +00:00
Workspaces are sub-layouts, they allow to define multiple layouts into a given
Fixed a typo share the buffer -> the buffers
2019-10-05 00:42:10 +00:00
layout, those layouts share the same buffers as the parent layout.
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
The currently active workspace number is displayed before the window number,
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
for instance "➊|➍" or "1|4" means the fourth window of the first workspace.
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
Update layouts and workspaces documentation
2016-03-21 02:00:45 +00:00
Any new layout comes with a default workspace which is the workspace 1.
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
Update layouts and workspaces documentation
2016-03-21 02:00:45 +00:00
Switching to a workspace that does not exist in the current layout will create a
new one. For instance at startup you can press ~SPC l w 2~ to create the
workspace 2 in the =default= layout.
When created a workspace is anonymous, you can give them a name with
~SPC l w R~.
*** Workspace key bindings
Doc: transient-state => transient state
2016-03-21 02:08:49 +00:00
The key bindings are registered in a transient state. The docstring of the
transient state displays the existing workspaces and the currently active
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
workspace has square brackets. Pressing a workspace number will activate it (or
Doc: transient-state => transient state
2016-03-21 02:08:49 +00:00
create a new one) and exit the transient state. It is possible to just preview a
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
workspace with ~Ctrl-<number>~. Pressing ~TAB~ will activate the previously
Update layouts and workspaces documentation
2016-03-21 02:00:45 +00:00
selected workspace.
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
Update layouts and workspaces documentation
2016-03-21 02:00:45 +00:00
Press ~?~ to toggle the full help.
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
|-------------------+-------------------------------------------------------------|
Add 'z' recenter bindings for various transient states By analogy with the "zz", "zb", "zt" vim / evil bindings, this adds an additional key binding "z" for `recenter-top-bottom` to the following transient states which navigate around the buffer in large jumps: - auto-symbol-highlight - error - buffer - vcs - org-babel This allows for repositioning of the buffer for visibility without having to exit the transient state. Minor updates are also made to documentation of other transient states.
2018-10-22 08:09:55 +00:00
| ~SPC l w~ | initiate transient state |
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
| ~?~ | toggle the documentation |
Update layout and workspace key binding documentation Changed the `[1..9, 0]` and `[C-1..C-9, C-0]` entries to `[0..9]` and `[C-0..C-9]`, in both the layout and workspace key bindings sections.
2017-02-01 11:45:04 +00:00
| ~[0..9]~ | switch to nth workspace |
| ~[C-0..C-9]~ | switch to nth workspace and keep the transient state active |
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
| ~TAB~ | switch to last active workspace |
| ~d~ | close current workspace |
| ~n~ or ~l~ | switch to next workspace |
| ~N~ or ~p~ or ~h~ | switch to previous workspace |
| ~R~ | set a tag to the current workspace |
| ~w~ | switched to tagged workspace |
Update layouts and workspaces documentation
2016-03-21 02:00:45 +00:00
There are also some handy globally available key bindings related to workspaces:
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Update layouts and workspaces documentation
2016-03-21 02:00:45 +00:00
|-------------+--------------------------------------|
| ~gt~ | go to next workspace |
Fix typo Fix typo
2017-02-19 11:30:15 +00:00
| ~gT~ | go to previous workspace |
Update layouts and workspaces documentation
2016-03-21 02:00:45 +00:00
| ~SPC b W~ | go to workspace and window by buffer |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
* Commands
** Vim key bindings
Add a tutorials section to SPC h T `SPC h T e` for `emacs-tutorial` (aliased from `help-with-tutorial` for a more descriptive name) `SPC h T v` for `evil-tutor-start` Added a wikipedia link to the `vi` article, where the origins of modal editing is discussed.
2019-05-18 11:47:29 +00:00
Spacemacs is based on the =Vim= modal user interface to navigate and edit text.
If you are not familiar with the =Vim= way of editing text, then you can try the
[[https://github.com/syl20bnr/evil-tutor][evil-tutor]] lessons by pressing ~SPC h T v~ at any time.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
*** Escaping
doc: Be consistent with ref to Spacemacs Use of =Spacemacs= vs Spacemacs is inconsistent. This picks Spacemacs as a convention
2015-10-12 23:12:09 +00:00
Spacemacs uses [[https://github.com/syl20bnr/evil-escape][evil-escape]] to
Format paragraphs/code/tables in DOCUMENTATION.org.
2015-09-05 08:03:36 +00:00
easily switch between =insert state= and =normal state= by quickly pressing the
~fd~ keys.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
The choice of ~fd~ was made to be able to use the same sequence to escape from
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
"everything" in Emacs:
Reformat documentation
2018-09-19 03:54:47 +00:00
- escape from all stock evil states to normal state
- escape from evil-lisp-state to normal state
- escape from evil-iedit-state to normal state
- abort evil ex command
- quit minibuffer
- abort isearch
- quit magit buffers
- quit help buffers
- quit apropos buffers
- quit ert buffers
- quit undo-tree buffer
- quit paradox
- quit gist-list menu
- quit helm-ag-edit
- hide neotree buffer
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
[doc] Fix some additional `SPC :` to `SPC SPC`
2016-02-07 13:39:54 +00:00
If you find yourself in a buffer where the Spacemacs (~SPC~) or Vim keybindings
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
don't work you can use this to get back to =normal state= (for example in ~SPC
[doc] Fix some additional `SPC :` to `SPC SPC`
2016-02-07 13:39:54 +00:00
SPC customize~ press ~fd~ to make ~SPC b b~ work again).
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Update doc for evil-escape
2015-09-02 04:02:26 +00:00
This sequence can be customized in your =~/.spacemacs=.
Example to set it to ~jj~:
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(defun dotspacemacs/user-config ()
(setq-default evil-escape-key-sequence "jj"))
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Consitently format Note: lines in DOCUMENTATION.org. Format is: *Note*: note here
2015-09-05 07:57:50 +00:00
*Note*: Although ~jj~ or ~jk~ are popular choices of vim users, these key
doc: Be consistent with ref to Spacemacs Use of =Spacemacs= vs Spacemacs is inconsistent. This picks Spacemacs as a convention
2015-10-12 23:12:09 +00:00
sequences are not optimal for Spacemacs. Indeed it is very easy in =visual
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
state= to press quickly ~jj~ and inadvertently escape to =normal state=.
*** Executing Vim and Emacs ex/M-x commands
Format documenation files with doc-fmt tool
2016-04-13 03:31:38 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Command | Key binding |
Update doc for evil-escape
2015-09-02 04:02:26 +00:00
|------------------+-------------|
| Vim (ex-command) | ~:~ |
dotfile: rename dotspacemacs-command-key for dotspacemacs-emacs-command-key And change the key from ":" to "SPC" This key does not try to bind evil ex-command anymore, it only bind M-x behind the leader key.
2016-01-09 06:53:24 +00:00
| Emacs (M-x) | ~SPC SPC~ |
The emacs command key ~SPC~ (executed after the leader key) can be changed
with the variable =dotspacemacs-emacs-command-key= of your =~/.spacemacs=.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
*** Leader key
doc: Be consistent with ref to Spacemacs Use of =Spacemacs= vs Spacemacs is inconsistent. This picks Spacemacs as a convention
2015-10-12 23:12:09 +00:00
On top of =Vim= modes (modes are called states in Spacemacs) there is a
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
special key called the leader key which once pressed gives a whole new keyboard
layer. The leader key is by default ~SPC~ (space). It is possible to change this
key with the variable =dotspacemacs-leader-key=.
doc: fix nesting
2017-04-10 04:07:10 +00:00
*** Major Mode leader key
Key bindings specific to the current =major mode= start with ~SPC m~. For
convenience a shortcut key called the major mode leader key is set by default on
~​,​~ which saves one precious keystroke.
It is possible to change the major mode leader key by defining the variable
=dotspacemacs-major-mode-leader-key= in your =~/.spacemacs=. For example to
setup the key on tabulation:
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(setq-default dotspacemacs-major-mode-leader-key "<tab>")
doc: fix nesting
2017-04-10 04:07:10 +00:00
#+END_SRC
Add doc for neotree VCS integration and evil text objects
2015-09-06 23:52:23 +00:00
*** Additional text objects
Additional text objects are defined in Spacemacs:
| Object | Description |
|---------+----------------------------|
| ~a~ | an argument |
| ~g~ | the entire buffer |
Add line text object using `evil-textobj-line`
2019-04-07 13:34:02 +00:00
| ~l~ | a line |
Add doc for neotree VCS integration and evil text objects
2015-09-06 23:52:23 +00:00
| ~$~ | text between =$= |
| ~*~ | text between =*= |
| ~8~ | text between =/*= and =*/= |
| ~%~ | text between =%= |
| ~\vert~ | text between =\vert= |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
** Reserved prefix command for user
Make SPC m o reserved for user
2015-08-17 18:25:48 +00:00
~SPC o~ and ~SPC m o~ are reserved for the user. Setting key bindings behind
doc: Be consistent with ref to Spacemacs Use of =Spacemacs= vs Spacemacs is inconsistent. This picks Spacemacs as a convention
2015-10-12 23:12:09 +00:00
these is *guaranteed* to never conflict with Spacemacs default key bindings.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Correct last `evil-leader/set-key` in documentation
2016-01-03 20:04:11 +00:00
*Example:* Put =(spacemacs/set-leader-keys "oc" 'org-capture)= inside
Documentation fixes. Fixes: - Typo - Code block indentation - Put keybindings on one line so they look nicer when viewed in Spacemacs - Make one sentence sound better
2017-04-18 06:05:28 +00:00
=dotspacemacs/user-config= in your =~/.spacemacs= file, to be able to use
~SPC o c~ to run org mode capture.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Add note about ivy/helm choice
2016-08-29 18:58:28 +00:00
** Completion
Typo in DOCUMENTATION.org
2016-09-01 02:34:57 +00:00
Spacemacs is powered by one of two incremental completion and selection
Add note about ivy/helm choice
2016-08-29 18:58:28 +00:00
narrowing frameworks: [[https://github.com/emacs-helm/helm][Helm]] (default) or [[https://github.com/abo-abo/swiper][Ivy]]. To use Ivy, add the =ivy= layer to
your list of enabled layers. If the =ivy= layer is not enabled, Helm will be
enabled automatically. (Please note that, as Helm is the more mature of the two,
some functions may be unavailable if you choose Ivy.)
These completion systems are the central control towers of Spacemacs, they are
used to manage buffers, projects, search results, configuration layers, toggles
and more...
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Add note about ivy/helm choice
2016-08-29 18:58:28 +00:00
Mastering your choice of completion system will make you a Spacemacs power user.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
For more information go to the layers documentation for [[https://github.com/syl20bnr/spacemacs/blob/master/layers/+completion/helm/README.org][Helm]] and [[https://github.com/syl20bnr/spacemacs/blob/master/layers/+completion/ivy/README.org][Ivy]].
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
*Note*: To open the Spacemacs documentation for Helm of Ivy in Emacs, open the
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
=spacemacs-help= menu with ~SPC h SPC~ and type ~helm~ or ~ivy~ then ~return~.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
** Discovering
*** Key bindings
Update docs for which-key
2015-08-26 12:07:46 +00:00
**** Which-key
Minor doc fixes
2015-08-29 14:05:58 +00:00
A help buffer is displayed each time the ~SPC~ key is pressed in normal mode.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
It lists the available key bindings and their associated commands.
Update docs for which-key
2015-08-26 12:07:46 +00:00
By default the [[https://github.com/justbur/emacs-which-key][which-key]] buffer will be displayed quickly after the key has been
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
pressed. You can change the delay by setting the variable
Changed 'the value is in second' to 'the value is in seconds'.
2017-11-19 04:35:56 +00:00
=dotspacemacs-which-key-delay= to your liking (the value is in seconds).
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Add toggles for specific persistent which-key keymaps Sometimes it is handy to show keymaps persistently with which-key. For example, to show navigation commands in Info-mode, gnus, eww etc. This PR implements handy toggles and documentation for that.
2021-01-08 20:27:08 +00:00
**** Which-key persistent
Sometimes it can be handy to show some keymap persistently with which-key,
documentation formatting: Sun Jan 10 20:15:44 UTC 2021
2021-01-10 20:15:44 +00:00
especially in buffers with merely evilified key bindings or using Emacs state,
Add toggles for specific persistent which-key keymaps Sometimes it is handy to show keymaps persistently with which-key. For example, to show navigation commands in Info-mode, gnus, eww etc. This PR implements handy toggles and documentation for that.
2021-01-08 20:27:08 +00:00
e.g. Info buffers, gnus, eww etc. The persistent =which-key= state can be
documentation formatting: Sun Jan 10 20:15:44 UTC 2021
2021-01-10 20:15:44 +00:00
toggled with ~SPC t k k~. For some specific keymaps, dedicated key bindings are
Add toggles for specific persistent which-key keymaps Sometimes it is handy to show keymaps persistently with which-key. For example, to show navigation commands in Info-mode, gnus, eww etc. This PR implements handy toggles and documentation for that.
2021-01-08 20:27:08 +00:00
also available behind the ~SPC t k~ prefix:
| Key binding | Description |
|-------------+---------------------------------------------------------------------|
| ~SPC t k k~ | toggle which-key persistent state |
| ~SPC t k m~ | show persistent major-mode keymap. Toggle off with ~SPC t k k~ |
| ~SPC t k M~ | show persistent full-major-mode keymap. Toggle off with ~SPC t k k~ |
| ~SPC t k t~ | show persistent top-level keymap. Toggle off with ~SPC t k k~ |
documentation formatting: Sun Jan 10 20:15:44 UTC 2021
2021-01-10 20:15:44 +00:00
The key bindings just set the =which-key-persistent-popup= to ~t~, hence the
which-key buffer will keep updating. Therefore the latter 3 key bindings (~SPC t
Add toggles for specific persistent which-key keymaps Sometimes it is handy to show keymaps persistently with which-key. For example, to show navigation commands in Info-mode, gnus, eww etc. This PR implements handy toggles and documentation for that.
2021-01-08 20:27:08 +00:00
k m/M/t~) can be used to return focus to their respective keymaps, while only
documentation formatting: Sun Jan 10 20:15:44 UTC 2021
2021-01-10 20:15:44 +00:00
the first key binding ~SPC t k k~ can be used for toggling off the persistent
Add toggles for specific persistent which-key keymaps Sometimes it is handy to show keymaps persistently with which-key. For example, to show navigation commands in Info-mode, gnus, eww etc. This PR implements handy toggles and documentation for that.
2021-01-08 20:27:08 +00:00
state.
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
**** Describe key bindings
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
It is possible to search for specific key bindings by pressing ~SPC ?~.
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
To narrow the list to some key bindings, use the leader key to type a pattern like
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
this regular expression: ~SPC\ b~ which would list all =buffer= related
bindings.
*** Getting help
=Describe functions= are powerful Emacs introspection commands to get
information about functions, variables, modes etc. These commands are bound
thusly:
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Update documentation for packages binding
2015-11-27 09:23:38 +00:00
|-------------+-----------------------------------------------------------|
Change `helm-apropos` from `SPC h d d` to `SPC h d a` Change the binding to be more mnemonic. It calls helm-[a]propos and it pretty much describes [a]ll.
2019-02-12 07:22:01 +00:00
| ~SPC h d a~ | describe current expression under point |
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
| ~SPC h d b~ | describe bindings |
Update documentation for packages binding
2015-11-27 09:23:38 +00:00
| ~SPC h d c~ | describe current character under point |
| ~SPC h d f~ | describe a function |
| ~SPC h d F~ | describe a face |
| ~SPC h d k~ | describe a key |
| ~SPC h d K~ | describe a keymap |
Add spacemacs/describe-last-keys
2016-01-11 20:47:04 +00:00
| ~SPC h d l~ | copy last pressed keys that you can paste in gitter chat |
Update documentation for packages binding
2015-11-27 09:23:38 +00:00
| ~SPC h d m~ | describe current modes |
core: misc. goodies for describe-package - Use completing-read when called interactively - Check for string locations in addition to built-in etc. - Don’t double-princ on/off for toggles - Bind to SPC hdP
2016-05-31 11:46:45 +00:00
| ~SPC h d p~ | describe a package (Emacs built-in function) |
| ~SPC h d P~ | describe a package (Spacemacs layer information) |
Update documentation for packages binding
2015-11-27 09:23:38 +00:00
| ~SPC h d s~ | copy system information that you can paste in gitter chat |
[core] Swap SPC h d t and SPC h d T As describing text feels more useful than describing themes.
2020-09-21 02:32:41 +00:00
| ~SPC h d t~ | describe text properties |
| ~SPC h d T~ | describe a theme |
Update documentation for packages binding
2015-11-27 09:23:38 +00:00
| ~SPC h d v~ | describe a variable |
Add describe evil ex-command functionality For introspection purposes it can be nice to have this functionality. Also this function can be used to discover which ex-commands are available.
2021-04-13 12:10:40 +00:00
| ~SPC h d x~ | describe an evil ex-command |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Other help key bindings:
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
|-------------+-------------------------------------------------------|
| ~SPC h SPC~ | discover Spacemacs documentation, layers and packages |
DOCUMENTATION.org: Add missing help keybindings All described in the changelog for 0.200.
2018-11-10 20:14:06 +00:00
| ~SPC h .~ | search dotfile variables |
Spacemacs documentation improvements `SPC f e f` key binding is no more present, so moved that table entry to `SPC h f` in DOCUMENTATION.org. corrected description of paste transient-state behavior.
2018-07-05 15:57:52 +00:00
| ~SPC h f~ | discover the =FAQ= |
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
| ~SPC h i~ | search in info pages with the symbol at point |
| ~SPC h k~ | show top-level bindings with =which-key= |
DOCUMENTATION.org: Add missing help keybindings All described in the changelog for 0.200.
2018-11-10 20:14:06 +00:00
| ~SPC h l~ | search layers |
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
| ~SPC h m~ | search available man pages |
| ~SPC h n~ | browse emacs news |
DOCUMENTATION.org: Add missing help keybindings All described in the changelog for 0.200.
2018-11-10 20:14:06 +00:00
| ~SPC h p~ | search packages |
| ~SPC h r~ | search documentation files |
| ~SPC h t~ | search toggles |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Adds some profiling keybinding under `SPC h P`
2017-07-26 17:25:51 +00:00
The =Profiler= is a tool that helps you identify why your editor is running
slowly or consumes a lot of memory. Here are key bindings relate to it:
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Adds some profiling keybinding under `SPC h P`
2017-07-26 17:25:51 +00:00
|-------------+-----------------------------|
| ~SPC h P k~ | stop the profiler |
| ~SPC h P r~ | display the profiler report |
| ~SPC h P s~ | start the profiler |
| ~SPC h P w~ | write the report to file |
change `mhh` for `gh` to follow-symbol in help buffers Also document the key bindings
2015-12-09 06:08:52 +00:00
Navigation key bindings in =help-mode=:
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
change `mhh` for `gh` to follow-symbol in help buffers Also document the key bindings
2015-12-09 06:08:52 +00:00
|--------------+-----------------------------------------------------|
Add toggles for specific persistent which-key keymaps Sometimes it is handy to show keymaps persistently with which-key. For example, to show navigation commands in Info-mode, gnus, eww etc. This PR implements handy toggles and documentation for that.
2021-01-08 20:27:08 +00:00
| ~J~ | scroll up (or next node) |
| ~K~ | scroll down (or next node) |
change `mhh` for `gh` to follow-symbol in help buffers Also document the key bindings
2015-12-09 06:08:52 +00:00
| ~g b~ or ~[~ | go back (same as clicking on =[back]= button) |
| ~g f~ or ~]~ | go forward (same as clicking on =[forward]= button) |
| ~g h~ | go to help for symbol under point |
Add a command for reporting issue to spacemacs
2016-01-24 23:17:31 +00:00
Reporting an issue:
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
core: update report-issue docs and docstring * core/core-spacemacs.el (spacemacs/report-issue): update docstring * doc/DOCUMENTATION.org (Reporting Issue table): reword key description to keep table width small Fix #5155
2016-04-14 12:04:14 +00:00
|-----------------+------------------------------------------------------------------------------------------|
| ~SPC h I~ | Open Spacemacs GitHub issue page with pre-filled information |
| ~SPC u SPC h I~ | Open Spacemacs GitHub issue page with pre-filled information - include last pressed keys |
doc: add remark for necessary GitHub login to report issues
2018-08-12 14:33:06 +00:00
*Note*: To be able to report an issue you need to be logged into GitHub
Update wording in DOCUMENTATION.org for readability and consistency.
2017-12-19 10:07:42 +00:00
*Note*: If these two bindings are used with the =*Backtrace*= buffer open, the
Add a command for reporting issue to spacemacs
2016-01-24 23:17:31 +00:00
backtrace is automatically included
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
*** Available layers
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
All layers can be easily discovered via =spacemacs-help= accessible with
~SPC h SPC~.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
The following actions on the selected candidate are available:
Reformat documentation
2018-09-19 03:54:47 +00:00
- default: open the layer =README.org=
- 2nd: open the layer =packages.el=
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
**** Available packages in Spacemacs
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
=spacemacs-help= also lists all the packages available in Spacemacs. The
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
entry format is =(layer) packages=. If you type =flycheck= you'll be able to see
spacemacs-helm: New layer Collect helm configuration from spacemacs and spacemacs-base into one place. The purpose is to allow choice between this layer and spacemacs-ivy.
2016-01-04 19:20:54 +00:00
all the layers where =flycheck= is used.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
The following actions are available on selected package:
Reformat documentation
2018-09-19 03:54:47 +00:00
- default: go the package init function
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
**** New packages from ELPA repositories
spacemacs-buffer: Distinguish types of updates Add a spacemacs update button to the spacemacs buffer, and relabel the package update button to read "Update Packages". This will hopefully resolve some confusion about updating spacemacs vs. updating the packages. I also tweaked the switch-to-version function to make it a little more verbose to use it for the spacemacs update button.
2015-10-12 21:00:59 +00:00
=package-list-packages= is where you can browse for all available packages in the
different Elpa repositories. It is possible to upgrade packages from there but
it is not recommended, use the =[Update Packages]= link on the Spacemacs startup
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
page instead.
doc: Be consistent with ref to Spacemacs Use of =Spacemacs= vs Spacemacs is inconsistent. This picks Spacemacs as a convention
2015-10-12 23:12:09 +00:00
Spacemacs uses [[https://github.com/Bruce-Connor/paradox][Paradox]] instead of =package-list-packages= to list available
Format paragraphs/code/tables in DOCUMENTATION.org.
2015-09-05 08:03:36 +00:00
ELPA packages. Paradox enhances the package list buffer with better feedbacks,
Fix capitalization of GitHub Change instances of "Github" to "GitHub".
2020-01-13 18:12:25 +00:00
new filters and GitHub information like the number of stars. Optionally you can
Format paragraphs/code/tables in DOCUMENTATION.org.
2015-09-05 08:03:36 +00:00
also star packages directly in the buffer.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
*Important Note 1*: Installing a new package from =Paradox= won't make it
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
persistent. To install a package persistently you have to add it explicitly to a
configuration layer.
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
*Important Note 2*: Don't /update/ your packages from =Paradox= or
=package-list-packages= because they don't support the rollback feature of
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Spacemacs.
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
|-------------+-------------------------------------------------------|
Update documentation for packages binding
2015-11-27 09:23:38 +00:00
| ~SPC a k~ | launch =paradox= |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
| ~/~ | evil-search |
| ~f k~ | filter by keywords |
| ~f r~ | filter by regexp |
| ~f u~ | display only installed package with updates available |
| ~h~ | go left |
| ~H~ | show help (not accurate) |
| ~j~ | go down |
| ~k~ | go up |
| ~l~ | go right |
| ~L~ | show last commits |
| ~n~ | next search occurrence |
| ~N~ | previous search occurrence |
| ~o~ | open package homepage |
| ~r~ | refresh |
| ~S P~ | sort by package name |
| ~S S~ | sort by status (installed, available, etc...) |
Fix capitalization of GitHub Change instances of "Github" to "GitHub".
2020-01-13 18:12:25 +00:00
| ~S *~ | sort by GitHub stars |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
| ~v~ | =visual state= |
| ~V~ | =visual-line state= |
| ~x~ | execute (action flags) |
*** Toggles
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
=spacemacs-help= is also a central place to discover the available toggles.
To display only the toggles source press ~C-l~.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
The following actions are available on selected toggle:
Reformat documentation
2018-09-19 03:54:47 +00:00
- default: toggle on/off
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
** Navigating
*** Point/Cursor
Navigation is performed using the Vi key bindings ~hjkl~.
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
|-------------+-----------------------------------------------------------------------------------|
| ~h~ | move cursor left |
| ~j~ | move cursor down |
| ~k~ | move cursor up |
| ~l~ | move cursor right |
Update docs for H and L H and L no longer move the cursor 10 lines up or down. Not sure how or when they did before, but they don't anymore, so the docs should reflect that.
2015-08-24 23:04:46 +00:00
| ~H~ | move cursor to the top of the screen |
| ~L~ | move cursor to the bottom of the screen |
keybindings: Add SPC j for jumping Use mnemonic j for jumping commands. Although some of these commands exist in other places, they are duplicated here when they don't conflict. Add: 1. jb for bookmark-jump 2. jc for avy char jump 3. jd for dired-jump 4. jD for dired-jump-other-window 5. jf for find-function-at-point 6. ji for spacemacs/jump-in-buffer (imenu) 7. jI for helm imenu in all buffers 8. jl for avy go to line 9. ju for avy-pop-mark (u for "undo") 10. jU for spacmacs/avy-goto-url 11. jv for find-variable-at-point 12. jw for avy go to word or subword Move: 1. jh to j0 (push mark and go to beginning of line) 1. jl to j$ (push mark and go to end of line)
2015-12-28 02:13:57 +00:00
| ~SPC j 0~ | go to the beginning of line (and set a mark at the previous location in the line) |
| ~SPC j $~ | go to the end of line (and set a mark at the previous location in the line) |
`SPC z z` -> `SPC t -` in DOCUMENTATION.org
2015-06-16 14:20:20 +00:00
| ~SPC t -~ | lock the cursor at the center of the screen |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
**** Smooth scrolling
[[https://github.com/aspiers/smooth-scrolling][smooth-scrolling]] prevent the point to jump when it reaches the top or
bottom of the screen. It is enabled by default.
On Windows, you may want to disable it. To disable the smooth scrolling set the
=dotspacemacs-smooth-scrolling= variable in your =~/.spacemacs= to =nil=:
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(setq-default dotspacemacs-smooth-scrolling nil)
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Update, simplify and add smooth scrolling toggle on `SPC t v`
2016-03-02 14:13:09 +00:00
You can also toggle smooth scrolling with ~SPC t v~.
bind avy-goto-line to `SPC y` After the change in 1d340dcc779f79d1767b9401b9f5a7128a7c2c33, there was some grumbling in gitter that `SPC L` is not as convenient as `SPC l`. Apparently avy-goto-line is a popular function. `SPC y` is chosen because it is: - currently unused (as far as I can tell). - sort of mnemonic because "avy" has a "y" in it. - doesn't require SHIFT to type - is accessible even on non-US keyboards (there were suggestions such ";" and "\" that are not as accessible on non-US keyboards) This change also updates the documentation regarding the change from ace-jump-mode to avy.
2015-11-05 23:49:25 +00:00
*** Vim motions with avy
Spacemacs uses the =evil= integration of [[https://github.com/abo-abo/avy][avy]] which enables the
invocation of =avy= during motions.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Fix docs to provide correct keybindings for Avy
2016-01-15 13:42:47 +00:00
For instance, it is useful for deleting a set of visual lines from the current line.
Try the following sequence in a buffer containing some text: ~d SPC j l~, followed by
selecting an avy candidate.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
|-------------+----------------------------------------------------|
Delete `SPC j b` and move `SPC j u` to `SPC j b` By convention, jump back should be on `b`, not `u` Since `SPC j u` is free, move as well `SPC j U` to `SPC j u`. `SPC j b` for bookmark jump is already available under `SPC f b`
2016-03-22 00:02:56 +00:00
| ~SPC j b~ | go back to the previous location (before the jump) |
Fix docs to provide correct keybindings for Avy
2016-01-15 13:42:47 +00:00
| ~SPC j j~ | initiate avy jump char |
| ~SPC j w~ | initiate avy jump word |
| ~SPC j l~ | initiate avy jump line |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
**** ace-link mode
bind avy-goto-line to `SPC y` After the change in 1d340dcc779f79d1767b9401b9f5a7128a7c2c33, there was some grumbling in gitter that `SPC L` is not as convenient as `SPC l`. Apparently avy-goto-line is a popular function. `SPC y` is chosen because it is: - currently unused (as far as I can tell). - sort of mnemonic because "avy" has a "y" in it. - doesn't require SHIFT to type - is accessible even on non-US keyboards (there were suggestions such ";" and "\" that are not as accessible on non-US keyboards) This change also updates the documentation regarding the change from ace-jump-mode to avy.
2015-11-05 23:49:25 +00:00
Similar to =avy=, [[https://github.com/abo-abo/ace-link][ace-link]] allows one to jump to any link in
Restore old ace bindings and revise documentation changes
2020-12-29 20:29:50 +00:00
=help-mode=, =woman-mode= and =info-mode=.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Restore old ace bindings and revise documentation changes
2020-12-29 20:29:50 +00:00
| Key binding | Description |
|-------------+-----------------------------------------------------------|
| ~o~ | initiate ace link mode in =help=, =info= and =woman-mode= |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Move unimpaired to spacemacs layer
2016-01-18 04:28:09 +00:00
*** Unimpaired bindings
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
Spacemacs comes with a built-in port of [[https://github.com/tpope/vim-unimpaired][tpope's vim-unimpaired]].
Move unimpaired to spacemacs layer
2016-01-18 04:28:09 +00:00
This plugin provides several pairs of bracket maps using ~[~ to denote
previous, and ~]~ as next.
documentation fixes: Tue Oct 23 14:18:21 UTC 2018
2018-10-23 14:18:21 +00:00
| Key bindings | Description |
|--------------+----------------------------------|
| ~[ SPC~ | Insert space above |
| ~] SPC~ | Insert space below |
| ~[ b~ | Go to previous buffer |
| ~] b~ | Go to next buffer |
| ~[ f~ | Go to previous file in directory |
| ~] f~ | Go to next file in directory |
| ~[ l~ | Go to the previous error |
| ~] l~ | Go to the next error |
| ~[ h~ | Go to the previous vcs hunk |
| ~] h~ | Go to the next vcs hunk |
| ~[ q~ | Go to the previous error |
| ~] q~ | Go to the next error |
| ~[ t~ | Go to the previous frame |
| ~] t~ | Go to the next frame |
| ~[ w~ | Go to the previous window |
| ~] w~ | Go to the next window |
| ~[ e~ | Move line up |
| ~] e~ | Move line down |
| ~[ p~ | Paste above current line |
| ~] p~ | Paste below current line |
| ~g p~ | Select pasted text |
Move unimpaired to spacemacs layer
2016-01-18 04:28:09 +00:00
Optimize SPC j prefix `SPC j j` is now for avy-goto-char (SPC SPC in 0.105) `SPC j J` is for avy-goto-char-2 `SPC j s` is for splitting strings or sexps `SPC j S` is for splitting strings of sexps, insert new line and indent `SPC j n` is to split line at point, insert new line and indent
2016-01-12 06:17:41 +00:00
*** Jumping, Joining and Splitting
The ~SPC j~ prefix is for jumping, joining and splitting.
**** Jumping
keybindings: Add SPC j for jumping Use mnemonic j for jumping commands. Although some of these commands exist in other places, they are duplicated here when they don't conflict. Add: 1. jb for bookmark-jump 2. jc for avy char jump 3. jd for dired-jump 4. jD for dired-jump-other-window 5. jf for find-function-at-point 6. ji for spacemacs/jump-in-buffer (imenu) 7. jI for helm imenu in all buffers 8. jl for avy go to line 9. ju for avy-pop-mark (u for "undo") 10. jU for spacmacs/avy-goto-url 11. jv for find-variable-at-point 12. jw for avy go to word or subword Move: 1. jh to j0 (push mark and go to beginning of line) 1. jl to j$ (push mark and go to end of line)
2015-12-28 02:13:57 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
keybindings: Add SPC j for jumping Use mnemonic j for jumping commands. Although some of these commands exist in other places, they are duplicated here when they don't conflict. Add: 1. jb for bookmark-jump 2. jc for avy char jump 3. jd for dired-jump 4. jD for dired-jump-other-window 5. jf for find-function-at-point 6. ji for spacemacs/jump-in-buffer (imenu) 7. jI for helm imenu in all buffers 8. jl for avy go to line 9. ju for avy-pop-mark (u for "undo") 10. jU for spacmacs/avy-goto-url 11. jv for find-variable-at-point 12. jw for avy go to word or subword Move: 1. jh to j0 (push mark and go to beginning of line) 1. jl to j$ (push mark and go to end of line)
2015-12-28 02:13:57 +00:00
|-------------+-----------------------------------------------------------------------------------|
| ~SPC j 0~ | go to the beginning of line (and set a mark at the previous location in the line) |
Change `SPC j C` to `SPC j (` to jump to fist unbalanced parens
2019-06-26 03:49:21 +00:00
| ~SPC j (~ | jump to first unbalanced parentheses |
keybindings: Add SPC j for jumping Use mnemonic j for jumping commands. Although some of these commands exist in other places, they are duplicated here when they don't conflict. Add: 1. jb for bookmark-jump 2. jc for avy char jump 3. jd for dired-jump 4. jD for dired-jump-other-window 5. jf for find-function-at-point 6. ji for spacemacs/jump-in-buffer (imenu) 7. jI for helm imenu in all buffers 8. jl for avy go to line 9. ju for avy-pop-mark (u for "undo") 10. jU for spacmacs/avy-goto-url 11. jv for find-variable-at-point 12. jw for avy go to word or subword Move: 1. jh to j0 (push mark and go to beginning of line) 1. jl to j$ (push mark and go to end of line)
2015-12-28 02:13:57 +00:00
| ~SPC j $~ | go to the end of line (and set a mark at the previous location in the line) |
Delete `SPC j b` and move `SPC j u` to `SPC j b` By convention, jump back should be on `b`, not `u` Since `SPC j u` is free, move as well `SPC j U` to `SPC j u`. `SPC j b` for bookmark jump is already available under `SPC f b`
2016-03-22 00:02:56 +00:00
| ~SPC j b~ | undo a jump (go back to previous location) |
Change `SPC ,` to `SPC j c` to go to last change
2019-06-26 03:52:21 +00:00
| ~SPC j c~ | go to last change |
keybindings: Add SPC j for jumping Use mnemonic j for jumping commands. Although some of these commands exist in other places, they are duplicated here when they don't conflict. Add: 1. jb for bookmark-jump 2. jc for avy char jump 3. jd for dired-jump 4. jD for dired-jump-other-window 5. jf for find-function-at-point 6. ji for spacemacs/jump-in-buffer (imenu) 7. jI for helm imenu in all buffers 8. jl for avy go to line 9. ju for avy-pop-mark (u for "undo") 10. jU for spacmacs/avy-goto-url 11. jv for find-variable-at-point 12. jw for avy go to word or subword Move: 1. jh to j0 (push mark and go to beginning of line) 1. jl to j$ (push mark and go to end of line)
2015-12-28 02:13:57 +00:00
| ~SPC j d~ | jump to a listing of the current directory |
| ~SPC j D~ | jump to a listing of the current directory (other window) |
Remove SPC j F and SPC j V and add SPC m g G in Emacs Lisp SPC j F and SPC j V don't fit the SPC j prefix because they require the thing under point to be an Emacs lisp thing, which means that these bindings should be major mode specific. To replace them and accordingly to the convention the key bindings SPC m g G in Emacs Lisp buffers has been added to go to definition in other window. SPC j f and SPC j v (minus letters) don't require the current buffer to be Emacs Lisp and thus I only updated the documentation about them mentioning that they're about Emacs Lisp variables and functions.
2016-08-26 01:19:21 +00:00
| ~SPC j f~ | jump to the definition of an Emacs Lisp function |
keybindings: Add SPC j for jumping Use mnemonic j for jumping commands. Although some of these commands exist in other places, they are duplicated here when they don't conflict. Add: 1. jb for bookmark-jump 2. jc for avy char jump 3. jd for dired-jump 4. jD for dired-jump-other-window 5. jf for find-function-at-point 6. ji for spacemacs/jump-in-buffer (imenu) 7. jI for helm imenu in all buffers 8. jl for avy go to line 9. ju for avy-pop-mark (u for "undo") 10. jU for spacmacs/avy-goto-url 11. jv for find-variable-at-point 12. jw for avy go to word or subword Move: 1. jh to j0 (push mark and go to beginning of line) 1. jl to j$ (push mark and go to end of line)
2015-12-28 02:13:57 +00:00
| ~SPC j i~ | jump to a definition in buffer (imenu) |
| ~SPC j I~ | jump to a definition in any buffer (imenu) |
Replace SPC j j and SPC j J by evil-avy-goto-char-timer evil-avy-goto-char-timer is a better all around solution.
2018-01-15 21:41:24 +00:00
| ~SPC j j~ | jump to one or more characters in the buffer (works as an evil motion) |
Remove undocumented and duplicated SPC j m and update doc.
2016-01-09 06:30:05 +00:00
| ~SPC j k~ | jump to next line and indent it using auto-indent rules |
| ~SPC j l~ | jump to a line with avy (works as an evil motion) |
Delete `SPC j b` and move `SPC j u` to `SPC j b` By convention, jump back should be on `b`, not `u` Since `SPC j u` is free, move as well `SPC j U` to `SPC j u`. `SPC j b` for bookmark jump is already available under `SPC f b`
2016-03-22 00:02:56 +00:00
| ~SPC j u~ | jump to a URL in the current buffer |
Add `spacemacs/iwb-region-or-buffer'.
2019-08-10 18:05:47 +00:00
| ~SPC j U~ | select a URL in the current buffer and follow it |
Remove SPC j F and SPC j V and add SPC m g G in Emacs Lisp SPC j F and SPC j V don't fit the SPC j prefix because they require the thing under point to be an Emacs lisp thing, which means that these bindings should be major mode specific. To replace them and accordingly to the convention the key bindings SPC m g G in Emacs Lisp buffers has been added to go to definition in other window. SPC j f and SPC j v (minus letters) don't require the current buffer to be Emacs Lisp and thus I only updated the documentation about them mentioning that they're about Emacs Lisp variables and functions.
2016-08-26 01:19:21 +00:00
| ~SPC j v~ | jump to the definition/declaration of an Emacs Lisp variable |
Remove undocumented and duplicated SPC j m and update doc.
2016-01-09 06:30:05 +00:00
| ~SPC j w~ | jump to a word in the current buffer (works as an evil motion) |
keybindings: Add SPC j for jumping Use mnemonic j for jumping commands. Although some of these commands exist in other places, they are duplicated here when they don't conflict. Add: 1. jb for bookmark-jump 2. jc for avy char jump 3. jd for dired-jump 4. jD for dired-jump-other-window 5. jf for find-function-at-point 6. ji for spacemacs/jump-in-buffer (imenu) 7. jI for helm imenu in all buffers 8. jl for avy go to line 9. ju for avy-pop-mark (u for "undo") 10. jU for spacmacs/avy-goto-url 11. jv for find-variable-at-point 12. jw for avy go to word or subword Move: 1. jh to j0 (push mark and go to beginning of line) 1. jl to j$ (push mark and go to end of line)
2015-12-28 02:13:57 +00:00
Optimize SPC j prefix `SPC j j` is now for avy-goto-char (SPC SPC in 0.105) `SPC j J` is for avy-goto-char-2 `SPC j s` is for splitting strings or sexps `SPC j S` is for splitting strings of sexps, insert new line and indent `SPC j n` is to split line at point, insert new line and indent
2016-01-12 06:17:41 +00:00
**** Joining and splitting
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Optimize SPC j prefix `SPC j j` is now for avy-goto-char (SPC SPC in 0.105) `SPC j J` is for avy-goto-char-2 `SPC j s` is for splitting strings or sexps `SPC j S` is for splitting strings of sexps, insert new line and indent `SPC j n` is to split line at point, insert new line and indent
2016-01-12 06:17:41 +00:00
|-------------+--------------------------------------------------------------------------|
| ~J~ | join the current line with the next line |
| ~SPC j k~ | go to next line and indent it using auto-indent rules |
| ~SPC j n~ | split the current line at point, insert a new line and auto-indent |
Add key binding SPC d w SPC for built-in commnand just-one-space
2017-04-23 17:01:34 +00:00
| ~SPC j o~ | split the current line at point but let point on current line |
Optimize SPC j prefix `SPC j j` is now for avy-goto-char (SPC SPC in 0.105) `SPC j J` is for avy-goto-char-2 `SPC j s` is for splitting strings or sexps `SPC j S` is for splitting strings of sexps, insert new line and indent `SPC j n` is to split line at point, insert new line and indent
2016-01-12 06:17:41 +00:00
| ~SPC j s~ | split a quoted string or s-expression in place |
| ~SPC j S~ | split a quoted string or s-expression, insert a new line and auto-indent |
Add `spacemacs/iwb-region-or-buffer'.
2019-08-10 18:05:47 +00:00
| ~SPC j =~ | format the marked region or entire buffer |
| ~SPC j +~ | format the marked region or entire buffer also cleanup whitespace |
Optimize SPC j prefix `SPC j j` is now for avy-goto-char (SPC SPC in 0.105) `SPC j J` is for avy-goto-char-2 `SPC j s` is for splitting strings or sexps `SPC j S` is for splitting strings of sexps, insert new line and indent `SPC j n` is to split line at point, insert new line and indent
2016-01-12 06:17:41 +00:00
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
*** Window manipulation
**** Window manipulation key bindings
Every window has a number displayed at the start of the mode-line and
can be quickly accessed using =SPC number=.
Make treemacs the default file browser.
2019-01-19 15:25:26 +00:00
| Key binding | Description |
|-------------+-----------------------|
| ~SPC 1~ | go to window number 1 |
| ~SPC 2~ | go to window number 2 |
| ~SPC 3~ | go to window number 3 |
| ~SPC 4~ | go to window number 4 |
| ~SPC 5~ | go to window number 5 |
| ~SPC 6~ | go to window number 6 |
| ~SPC 7~ | go to window number 7 |
| ~SPC 8~ | go to window number 8 |
| ~SPC 9~ | go to window number 9 |
Window number 0 is a special case and selects sidebar windows, like treemacs. If there is no window
Update documentation on window manipulation to clarify behavior of window 0
2017-04-20 21:39:33 +00:00
number 0, =SPC 0= attempts to select window number 10.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Windows manipulation commands (start with ~w~):
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
|------------------------+-----------------------------------------------------------------------------|
Add keybinding for spacemacs/alternate-window spacemacs/alternate-window was suggested to switch between the last selected window, or the window-analog of SPC TAB (spacemacs/alternate-buffer). This is part of a larger family of functions, such as spacemacs/jump-to-last-layout on SPC l TAB and eyebrowse-last-window-config on SPC l w TAB. Resolves #7845
2016-12-25 06:15:35 +00:00
| ~SPC w TAB~ | switch to alternate window in the current frame (switch back and forth) |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
| ~SPC w =~ | balance split windows |
Document maximize window horizontally and vertically
2018-01-06 16:18:08 +00:00
| ~SPC w _~ | maximize window horizontally |
| ~SPC w \vert~ | maximize window vertically |
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
| ~SPC w b~ | force the focus back to the minibuffer |
document new centering key bindings
2019-01-28 05:11:58 +00:00
| ~SPC w c c~ | toggle visual centering of the current buffer |
| ~SPC w c C~ | toggle visual distraction free mode |
| ~SPC w c .~ | center buffer and enable centering transient state |
Replace close words by delete in documentation
2016-02-15 04:11:52 +00:00
| ~SPC w d~ | delete a window |
Refactor SPC w and SPC b regarding deletion The motivation is to clean redundent actions and bring more consistency between `SPC b` and `SPC w` by: - using capital letters for ace-window actions - reusing the same letters between window and buffer when possible - adding support for universal prefix argument to delete both window and buffer Details of changes: Buffer - `SPC b k` has been removed since the functionality is available directly in Helm by selecting the kill buffer action - `SPC b m` (buffer move) has been removed because the functionality is available via `SPC w` with `SPC w h/j/k/l`, `SPC w H/J/K/L` and `SPC w M` (see window section for the new `SPC w M`). - `SPC b K` (kill other buffers) is now `SPC b m` to map with `SPC w m` (kill other window or maximize). Using the universal prefix argument `SPC u SPC b m` will also kill the windows. - `SPC b C-k` (kill buffer matching regexp) is now simply on `SPC b k`. - `SPC b D` now kills a buffer using ace-window. - `SPC b d` and `SPC b D` now accept an universal prefix argument to also delete the window. So `SPC u SPC b d` and `SPC u SPC b D` delete the buffer and the window. Window - `SPC w M` now swap the window using ace-window. - old `SPC w M` (center window) is now on `SPC w c` and `SPC w C` uses ace-window. - `SPC w SPC` (select window) is now on `SPC w W` since it uses ace-window. - `SPC w d` and `SPC w D` now accepts an universal prefix argument to delete the window and the buffer.
2016-06-26 03:40:41 +00:00
| ~SPC u SPC w d~ | delete a window and its current buffer (does not delete the file) |
| ~SPC w D~ | delete another window using [[https://github.com/abo-abo/ace-window][ace-window]] |
| ~SPC u SPC w D~ | delete another window and its current buffer using [[https://github.com/abo-abo/ace-window][ace-window]] |
Switch “bc”->“bd” and “wc”->“wd” Also: - switch spacemacs layouts to the same. - Add “wD” for ace-delete-window - switch window dedication toggle to “wt” - all documentation has been updated to reflect these changes Closes #5031
2016-02-12 08:08:48 +00:00
| ~SPC w t~ | toggle window dedication (dedicated window cannot be reused by a mode) |
added follow mode key binding
2016-01-22 23:51:43 +00:00
| ~SPC w f~ | toggle follow mode |
Add make-frame shortcut, SPC w F Placed it under the `SPC w` prefix since the related `other-frame` is set to `SPC w o`. Signed-off-by: JP-Ellis <josh@jpellis.me>
2016-05-18 06:59:38 +00:00
| ~SPC w F~ | create new frame |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
| ~SPC w h~ | move to window on the left |
| ~SPC w H~ | move window to the left |
| ~SPC w j~ | move to window below |
| ~SPC w J~ | move window to the bottom |
| ~SPC w k~ | move to window above |
| ~SPC w K~ | move window to the top |
| ~SPC w l~ | move to window on the right |
| ~SPC w L~ | move window to the right |
| ~SPC w m~ | maximize/minimize a window (maximize is equivalent to delete other windows) |
Refactor SPC w and SPC b regarding deletion The motivation is to clean redundent actions and bring more consistency between `SPC b` and `SPC w` by: - using capital letters for ace-window actions - reusing the same letters between window and buffer when possible - adding support for universal prefix argument to delete both window and buffer Details of changes: Buffer - `SPC b k` has been removed since the functionality is available directly in Helm by selecting the kill buffer action - `SPC b m` (buffer move) has been removed because the functionality is available via `SPC w` with `SPC w h/j/k/l`, `SPC w H/J/K/L` and `SPC w M` (see window section for the new `SPC w M`). - `SPC b K` (kill other buffers) is now `SPC b m` to map with `SPC w m` (kill other window or maximize). Using the universal prefix argument `SPC u SPC b m` will also kill the windows. - `SPC b C-k` (kill buffer matching regexp) is now simply on `SPC b k`. - `SPC b D` now kills a buffer using ace-window. - `SPC b d` and `SPC b D` now accept an universal prefix argument to also delete the window. So `SPC u SPC b d` and `SPC u SPC b D` delete the buffer and the window. Window - `SPC w M` now swap the window using ace-window. - old `SPC w M` (center window) is now on `SPC w c` and `SPC w C` uses ace-window. - `SPC w SPC` (select window) is now on `SPC w W` since it uses ace-window. - `SPC w d` and `SPC w D` now accepts an universal prefix argument to delete the window and the buffer.
2016-06-26 03:40:41 +00:00
| ~SPC w M~ | swap windows using [[https://github.com/abo-abo/ace-window][ace-window]] |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
| ~SPC w o~ | cycle and focus between frames |
| ~SPC w p m~ | open messages buffer in a popup window |
| ~SPC w p p~ | close the current sticky popup window |
added/corrected, rotate keybindings In the "Windows manipulation commands (start with ~w~):" section: Added the `SPC w r` keybinding: | ~SPC w r~ | rotate windows forward | In the `SPC w R` keybinding description, replaced "clockwise" with "backward". | ~SPC w R~ | rotate windows backward | In the "Window manipulation transient state" section: Added the`r` keybinding. | ~r~ | rotate windows forward | In the `R` keybinding description, added "backward" | ~R~ | rotate windows backward |
2016-08-20 12:29:07 +00:00
| ~SPC w r~ | rotate windows forward |
| ~SPC w R~ | rotate windows backward |
Fix horizontal/vertical splits documentation (-, /)
2015-12-26 03:00:33 +00:00
| ~SPC w s~ or ~SPC w -~ | horizontal split |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
| ~SPC w S~ | horizontal split and focus new window |
| ~SPC w u~ | undo window layout (used to effectively undo a closed window) |
| ~SPC w U~ | redo window layout |
Fix horizontal/vertical splits documentation (-, /)
2015-12-26 03:00:33 +00:00
| ~SPC w v~ or ~SPC w /~ | vertical split |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
| ~SPC w V~ | vertical split and focus new window |
| ~SPC w w~ | cycle and focus between windows |
Refactor SPC w and SPC b regarding deletion The motivation is to clean redundent actions and bring more consistency between `SPC b` and `SPC w` by: - using capital letters for ace-window actions - reusing the same letters between window and buffer when possible - adding support for universal prefix argument to delete both window and buffer Details of changes: Buffer - `SPC b k` has been removed since the functionality is available directly in Helm by selecting the kill buffer action - `SPC b m` (buffer move) has been removed because the functionality is available via `SPC w` with `SPC w h/j/k/l`, `SPC w H/J/K/L` and `SPC w M` (see window section for the new `SPC w M`). - `SPC b K` (kill other buffers) is now `SPC b m` to map with `SPC w m` (kill other window or maximize). Using the universal prefix argument `SPC u SPC b m` will also kill the windows. - `SPC b C-k` (kill buffer matching regexp) is now simply on `SPC b k`. - `SPC b D` now kills a buffer using ace-window. - `SPC b d` and `SPC b D` now accept an universal prefix argument to also delete the window. So `SPC u SPC b d` and `SPC u SPC b D` delete the buffer and the window. Window - `SPC w M` now swap the window using ace-window. - old `SPC w M` (center window) is now on `SPC w c` and `SPC w C` uses ace-window. - `SPC w SPC` (select window) is now on `SPC w W` since it uses ace-window. - `SPC w d` and `SPC w D` now accepts an universal prefix argument to delete the window and the buffer.
2016-06-26 03:40:41 +00:00
| ~SPC w W~ | select window using [[https://github.com/abo-abo/ace-window][ace-window]] |
Add doc for SPC b x and SPC w x
2018-01-13 04:20:30 +00:00
| ~SPC w x~ | delete a window and its current buffer (does not delete the file) |
Add 'SPC w' leader bindings for window resizing For convenience they directly enter the window manipulation transient state, since resizing operations tend to involve repeated key presses.
2018-10-27 12:26:21 +00:00
| ~SPC w [~ | shrink window horizontally (enter transient state) |
| ~SPC w ]~ | enlarge window horizontally (enter transient state) |
| ~SPC w {~ | shrink window vertically (enter transient state) |
| ~SPC w }~ | enlarge window vertically (enter transient state) |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Window splitting with custom delete Implements some custom window layout splitting functions.
2018-05-14 21:05:07 +00:00
Split the current window into multiple ones, deleting all others using the
following commands:
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Window splitting with custom delete Implements some custom window layout splitting functions.
2018-05-14 21:05:07 +00:00
|-------------+-------------------------------------------|
| ~SPC w 1~ | make 1 window layout |
| ~SPC w 2~ | make 2 windows layout (split vertically) |
| ~SPC w 3~ | make 3 windows layout (split vertically) |
| ~SPC w 4~ | make 4 windows layout (split in 2x2 grid) |
By default, the commands above ignore some windows, like the filetrees (treemacs
and neotree) but you can use a prefix argument to force delete them.
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Window splitting with custom delete Implements some custom window layout splitting functions.
2018-05-14 21:05:07 +00:00
|-----------------+-------------------------------------------------------------|
| ~SPC u SPC w 1~ | make 1 window layout with force delete |
| ~SPC u SPC w 2~ | make 2 windows layout (split vertically) with force delete |
| ~SPC u SPC w 3~ | make 3 windows layout (split vertically) with force delete |
| ~SPC u SPC w 4~ | make 4 windows layout (split in 2x2 grid) with force delete |
You can also configure which windows get ignored when executing the above
commands by adding a prefix to the =spacemacs-window-split-ignore-prefixes=
list:
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(add-to-list 'spacemacs-window-split-ignore-prefixes "My Favourite Window")
Window splitting with custom delete Implements some custom window layout splitting functions.
2018-05-14 21:05:07 +00:00
#+END_SRC
Or if you want a certain ignored window to always be deleted you can remote it
from the list:
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(setq spacemacs-window-split-ignore-prefixes
(remove treemacs--buffer-name-prefix spacemacs-window-split-ignore-prefixes))
Window splitting with custom delete Implements some custom window layout splitting functions.
2018-05-14 21:05:07 +00:00
#+END_SRC
And if you want even more control over the way windows are removed you can
define your own deletion function:
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(defun my-delete-other-windows () (delete-other-windows))
(setq spacemacs-window-split-delete-function 'my-delete-other-windows)
Window splitting with custom delete Implements some custom window layout splitting functions.
2018-05-14 21:05:07 +00:00
#+END_SRC
Update transient state wording, etc. - Removed the word `Manipulation` from the transient state titles: - Buffer Manipulation Transient State and Window Manipulation TS - Expanded the TS abbreviation to Transient State - Documented the Buffer Transient State key binding: `q` to quit the transient state - Capitalized `Transient State` in the titles - Window Transient State: - Added a line break after the title in the folded hint. This allows for more keys to be visible horizontally. - Moved up the [?] help key after the title, so that it's in the same place in both the folded and full transient state.
2019-11-06 19:14:34 +00:00
**** Window transient state
A convenient window transient state allows for performing most of the actions
listed above. For example window resizing.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Document missing keybindings for window manipulation transient state
2019-11-21 22:13:50 +00:00
| Key binding | Description |
|-----------------+---------------------------------------------------------------|
| ~SPC w .~ | initiate transient state |
| ~?~ | display the full documentation in minibuffer |
| ~0~ | go to window number 0 |
| ~1~ | go to window number 1 |
| ~2~ | go to window number 2 |
| ~3~ | go to window number 3 |
| ~4~ | go to window number 4 |
| ~5~ | go to window number 5 |
| ~6~ | go to window number 6 |
| ~7~ | go to window number 7 |
| ~8~ | go to window number 8 |
| ~9~ | go to window number 9 |
| ~/~ | vertical split |
| ~-~ | horizontal split |
| ~\vert~ | maximize window vertically |
| ~_~ | maximize window horizontally |
| ~[~ | shrink window horizontally |
| ~]~ | enlarge window horizontally |
| ~{~ | shrink window vertically |
| ~}~ | enlarge window vertically |
| ~d~ | delete window |
| ~D~ | delete other windows |
| ~g~ | toggle =golden-ratio= on and off |
| ~h~ ~<left>~ | go to window on the left |
| ~j~ ~<down>~ | go to window below |
| ~k~ ~<up>~ | go to window above |
| ~l~ ~<right>~ | go to window on the right |
| ~H~ ~<S-left>~ | move window to the left |
| ~J~ ~<S-down>~ | move window to the bottom |
| ~K~ ~<S-up>~ | move bottom to the top |
| ~L~ ~<S-right>~ | move window to the right |
| ~m~ | toggle maximization of current window |
| ~o~ | focus other frame |
| ~a~ | call ace window mode |
| ~r~ | rotate windows forward |
| ~R~ | rotate windows backward |
| ~s~ | horizontal split |
| ~S~ | horizontal split and focus new window |
| ~u~ | undo window layout (used to effectively undo a closed window) |
| ~U~ | redo window layout |
| ~v~ | vertical split |
| ~V~ | vertical split and focus new window |
| ~w~ | focus other window |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
**** Golden ratio
If you resize windows like crazy you may want to give a try to [[https://github.com/roman/golden-ratio.el][golden-ratio]].
=golden-ratio= resizes windows dynamically depending on whether they are
selected or not. By default =golden-ratio= is off.
The mode can be toggled on and off with ~SPC t g~.
*** Buffers and Files
**** Buffers manipulation key bindings
Implement C(-S)-tab buffer switch in Helm layer Equivalent to PR #14287 for ivy-layer
2021-01-29 10:11:44 +00:00
With few exceptions, buffer manipulation commands (start with ~b~):
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Update documentation for SPC b n and SPC b p
2018-11-04 15:15:19 +00:00
|-----------------+----------------------------------------------------------------------------------------|
| ~SPC TAB~ | switch to alternate buffer in the current window (switch back and forth) |
Implement C(-S)-tab buffer switch in Helm layer Equivalent to PR #14287 for ivy-layer
2021-01-29 10:11:44 +00:00
| ~C-TAB/C-S tab~ | cycle backward/forward through previous visited buffers (i.e. scroll helm buffer list) |
Update documentation for SPC b n and SPC b p
2018-11-04 15:15:19 +00:00
| ~SPC b b~ | switch to a buffer |
| ~SPC b d~ | kill the current buffer (does not delete the visited file) |
| ~SPC u SPC b d~ | kill the current buffer and window (does not delete the visited file) |
| ~SPC b D~ | kill a visible buffer using [[https://github.com/abo-abo/ace-window][ace-window]] |
| ~SPC u SPC b D~ | kill a visible buffer and its window using [[https://github.com/abo-abo/ace-window][ace-window]] |
| ~SPC b C-d~ | kill other buffers |
| ~SPC b C-D~ | kill buffers using a regular expression |
| ~SPC b e~ | erase the content of the buffer (ask for confirmation) |
| ~SPC b h~ | open =*spacemacs*= home buffer |
| ~SPC b H~ | open or select the =*Help*= buffer |
| ~SPC b n~ | switch to next buffer avoiding buffers matching =spacemacs-useless-buffers-regexp= |
| ~SPC b m~ | open =*Messages*= buffer |
| ~SPC u SPC b m~ | kill all buffers and windows except the current one |
| ~SPC b M~ | kill all buffers matching the regexp |
| ~SPC b p~ | switch to previous buffer avoiding buffers matching =spacemacs-useless-buffers-regexp= |
| ~SPC b P~ | copy clipboard and replace buffer (useful when pasting from a browser) |
| ~SPC b R~ | revert the current buffer (reload from disk) |
| ~SPC b s~ | switch to the =*scratch*= buffer (create it if needed) |
| ~SPC b u~ | reopen the most recently killed file buffer |
| ~SPC b w~ | toggle read-only (writable state) |
| ~SPC b x~ | kill the current buffer and window (does not delete the visited file) |
| ~SPC b Y~ | copy whole buffer to clipboard (useful when copying to a browser) |
| ~z f~ | Make current function or comments visible in buffer as much as possible |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Move all "new empty buffer" key bindings under SPC b N and add documentation
2017-04-18 02:10:16 +00:00
**** Create a new empty buffer
Move indirect buffer key bindings to `SPC b N` prefix
2019-06-26 04:10:01 +00:00
| Key binding | Description |
|---------------+-------------------------------------------------------------------------------------------------|
| ~SPC b N h~ | create new empty buffer in a new window on the left |
| ~SPC b N C-i~ | create an indirect buffer from an existing opened buffer |
| ~SPC b N i~ | create an indirect buffer that is clone of currently opened buffer |
| ~SPC b N I~ | create an indirect buffer that is clone of currently opened buffer, and open it in other window |
| ~SPC b N j~ | create new empty buffer in a new window at the bottom |
| ~SPC b N k~ | create new empty buffer in a new window above |
| ~SPC b N l~ | create new empty buffer in a new window below |
| ~SPC b N n~ | create new empty buffer in current window |
Move all "new empty buffer" key bindings under SPC b N and add documentation
2017-04-18 02:10:16 +00:00
Update transient state wording, etc. - Removed the word `Manipulation` from the transient state titles: - Buffer Manipulation Transient State and Window Manipulation TS - Expanded the TS abbreviation to Transient State - Documented the Buffer Transient State key binding: `q` to quit the transient state - Capitalized `Transient State` in the titles - Window Transient State: - Added a line break after the title in the folded hint. This allows for more keys to be visible horizontally. - Moved up the [?] help key after the title, so that it's in the same place in both the folded and full transient state.
2019-11-06 19:14:34 +00:00
**** Buffers transient state
A convenient buffer transient state allows for quickly cycling through the
open buffers and closing them.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Add ivy option to buffer transient state
2018-10-27 12:22:32 +00:00
| Key binding | Description |
|------------------------+--------------------------------------------------------------------------------------------|
| ~SPC b .~ | initiate transient state |
| ~[1..9]~ | move current buffer to nth window |
| ~[C-1..C-9]~ | switch focus to nth window |
| ~[M-1..M-9]~ | swap current buffer with nth window |
| ~b~ | list all buffers with helm/ivy (avoid buffers matching =spacemacs-useless-buffers-regexp=) |
| ~d~ | kill current buffer |
| ~C-d~ | bury current buffer |
| ~n~ or ~<right>~ | go to next buffer (avoid buffers matching =spacemacs-useless-buffers-regexp=) |
| ~N~ or ~p~ or ~<left>~ | go to previous buffer (avoid buffers matching =spacemacs-useless-buffers-regexp=) |
| ~o~ | switch focus to other window |
| ~z~ | recenter buffer in window |
Update transient state wording, etc. - Removed the word `Manipulation` from the transient state titles: - Buffer Manipulation Transient State and Window Manipulation TS - Expanded the TS abbreviation to Transient State - Documented the Buffer Transient State key binding: `q` to quit the transient state - Capitalized `Transient State` in the titles - Window Transient State: - Added a line break after the title in the folded hint. This allows for more keys to be visible horizontally. - Moved up the [?] help key after the title, so that it's in the same place in both the folded and full transient state.
2019-11-06 19:14:34 +00:00
| ~q~ | quit transient state |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Unlike vim, emacs creates many buffers that most people do not need to see. Some
Documentation fixes. Fixes: - Typo - Code block indentation - Put keybindings on one line so they look nicer when viewed in Spacemacs - Make one sentence sound better
2017-04-18 06:05:28 +00:00
examples are the =*Messages*= and =*Compile-Log*= buffers. Spacemacs tries to
automatically ignore buffers that are not useful. However, you may want to
change the way Spacemacs marks buffers as useful. For instructions, see the
Convert new exporter into standalone tool
2017-07-29 07:41:05 +00:00
[[https://github.com/syl20bnr/spacemacs/blob/develop/doc/FAQ.org#change-special-buffer-rules][special buffer howto]].
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Update transient state wording, etc. - Removed the word `Manipulation` from the transient state titles: - Buffer Manipulation Transient State and Window Manipulation TS - Expanded the TS abbreviation to Transient State - Documented the Buffer Transient State key binding: `q` to quit the transient state - Capitalized `Transient State` in the titles - Window Transient State: - Added a line break after the title in the folded hint. This allows for more keys to be visible horizontally. - Moved up the [?] help key after the title, so that it's in the same place in both the folded and full transient state.
2019-11-06 19:14:34 +00:00
**** File manipulation key bindings
File manipulation commands (start with ~f~):
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
|-------------+--------------------------------------------------------------------------------------------------------|
Fixes keybinding conflict with `fasd` layer The `SPC f a` keybinding was already used by the `fasd` layer so a workaround had to be found for the newly introduced one. Refs: c2e377c902ba5cbed9ef6be47c3fa7f45a8bb846 Refs: #11224 Thanks @agzam for pointing it out and investigating potential solutions.
2018-08-29 21:13:43 +00:00
| ~SPC f A~ | open a file and replace the current buffer with the new file |
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
| ~SPC f b~ | go to file bookmarks |
| ~SPC f c~ | copy current file to a different location |
| ~SPC f C d~ | convert file from unix to dos encoding |
| ~SPC f C u~ | convert file from dos to unix encoding |
| ~SPC f D~ | delete a file and the associated buffer (ask for confirmation) |
| ~SPC f E~ | open a file with elevated privileges (sudo edit) |
| ~SPC f f~ | open file |
| ~SPC f F~ | try to open the file under point |
| ~SPC f h~ | open binary file with =hexl= (a hex editor) |
| ~SPC f j~ | jump to the current buffer file in dired |
| ~SPC f J~ | open a junk file, in mode determined by the file extension provided (defaulting to =fundamental mode=) |
| ~SPC f l~ | open file literally in =fundamental mode= |
| ~SPC f L~ | Locate a file (using =locate=) |
| ~SPC f o~ | open a file using the default external program |
| ~SPC f R~ | rename the current file |
| ~SPC f s~ | save a file |
| ~SPC f S~ | save all files |
| ~SPC f r~ | open a recent file |
documentation formatting: Sun Jan 20 15:34:11 UTC 2019
2019-01-20 15:34:11 +00:00
| ~SPC f t~ | toggle file tree side bar using [[https://github.com/Alexander-Miller/treemacs][Treemacs]] |
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
| ~SPC f v d~ | add a directory variable |
| ~SPC f v f~ | add a local variable to the current file |
| ~SPC f v p~ | add a local variable to the first line of the current file |
Multiple ways to copy a file path
2018-06-02 15:14:42 +00:00
| ~SPC f y c~ | show and copy current file absolute path with line and column number in the minibuffer |
| ~SPC f y d~ | show and copy current directory absolute path in the minibuffer |
| ~SPC f y l~ | show and copy current file absolute path with line number in the minibuffer |
DOCUMENTATION.org: fix typo
2018-10-05 09:57:10 +00:00
| ~SPC f y n~ | show and copy current file name with extension in the minibuffer |
| ~SPC f y N~ | show and copy current file name without extension in the minibuffer |
Multiple ways to copy a file path
2018-06-02 15:14:42 +00:00
| ~SPC f y y~ | show and copy current file absolute path in the minibuffer |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Added frame manipulation commands
2017-02-03 21:19:04 +00:00
**** Frame manipulation key bindings
Frame manipulation commands (start with ~F~):
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Added frame manipulation commands
2017-02-03 21:19:04 +00:00
|-------------+-----------------------------------------------------|
| ~SPC F f~ | open a file in another frame |
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
| ~SPC F d~ | delete the current frame (unless it's the only one) |
Change Frame delete bindings from c/C to d/D The Frame delete bindings SPC F c and C, are inconsistent with the delete window and buffer bindings, that use: d and D Changed the dired-other-frame binding from d to O
2017-10-20 08:36:43 +00:00
| ~SPC F D~ | delete all other frames |
Added frame manipulation commands
2017-02-03 21:19:04 +00:00
| ~SPC F b~ | open a buffer in another frame |
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
| ~SPC F B~ | open a buffer in another frame (but don't switch) |
Added frame manipulation commands
2017-02-03 21:19:04 +00:00
| ~SPC F o~ | cycle focus between frames |
Change Frame delete bindings from c/C to d/D The Frame delete bindings SPC F c and C, are inconsistent with the delete window and buffer bindings, that use: d and D Changed the dired-other-frame binding from d to O
2017-10-20 08:36:43 +00:00
| ~SPC F O~ | open a dired buffer in another frame |
Added frame manipulation commands
2017-02-03 21:19:04 +00:00
| ~SPC F n~ | create a new frame |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
**** Emacs and Spacemacs files
Convenient key bindings are located under the prefix ~SPC f e~ to quickly
doc: Be consistent with ref to Spacemacs Use of =Spacemacs= vs Spacemacs is inconsistent. This picks Spacemacs as a convention
2015-10-12 23:12:09 +00:00
navigate between =Emacs= and Spacemacs specific files.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
core: update environment variables management * add new dotfile function `dotspacemacs/user-env` * add ignored env. vars with variable spacemacs-ignored-environment-variables * ignore env vars: SSH_AUTH_SOCK and DBUS_SESSION_BUS_ADDRESS * update documentation in DOCUMENTATION.org * update .spacemacs.template with new function * rename environment file from spacemacs.env to .spacemacs.env * move location of .spacemacs.env file to home or dotdirectory * add a header to the generated .spacemacs.env file to explain what it is * make SPC f e e fallbacks to the function dotspacemacs/user-env if the user manages the env var by themselves * make SPC f e E call the new function dotspacemacs/user-env * sort environment variables in .spacemacs.env file
2018-07-03 05:20:06 +00:00
|---------------+---------------------------------------------------------------------------------------------------------|
| ~SPC f e d~ | open the spacemacs dotfile (=~/.spacemacs=) |
| ~SPC f e D~ | open =ediff= buffer of =~/.spacemacs= and =.spacemacs.template= |
| ~SPC f e e~ | open the =~/.spacemacs.env= file where environment variables are set or goes to =dotspacemacs/user-env= |
| ~SPC f e E~ | reload the environment variables by executing the function =dotspacemacs/user-env= |
| ~SPC f e C-e~ | reinitialize the =~/.spacemacs.env= file by importing system and shell environment variables |
| ~SPC f e i~ | open the all mighty =init.el= |
[defaults] Document new keybindings
2021-04-08 20:15:17 +00:00
| ~SPC f e I~ | open the =early-init.el= |
core: update environment variables management * add new dotfile function `dotspacemacs/user-env` * add ignored env. vars with variable spacemacs-ignored-environment-variables * ignore env vars: SSH_AUTH_SOCK and DBUS_SESSION_BUS_ADDRESS * update documentation in DOCUMENTATION.org * update .spacemacs.template with new function * rename environment file from spacemacs.env to .spacemacs.env * move location of .spacemacs.env file to home or dotdirectory * add a header to the generated .spacemacs.env file to explain what it is * make SPC f e e fallbacks to the function dotspacemacs/user-env if the user manages the env var by themselves * make SPC f e E call the new function dotspacemacs/user-env * sort environment variables in .spacemacs.env file
2018-07-03 05:20:06 +00:00
| ~SPC f e l~ | locate an Emacs library |
| ~SPC f e R~ | resync the dotfile with spacemacs |
| ~SPC f e U~ | update packages |
| ~SPC f e v~ | display and copy the spacemacs version |
Change recompile-elpa to a more emacs file specific keybinding
2019-11-24 20:48:25 +00:00
| ~SPC f e c~ | recompile all elpa packages |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
**** Browsing files in completion buffer
documentation fixes: Tue Oct 23 14:18:21 UTC 2018
2018-10-23 14:18:21 +00:00
In =vim= style and =hybrid= style with the variable
Fix some typos (#14832)
2021-06-06 23:43:22 +00:00
=hybrid-mode-enable-hjkl-bindings= set to =t=, you can navigate with ~hjkl~.
helm-find-files: use C-h and C-l to go up down a directory Import TheBB configuration into Spacemacs and add `C-S-h` to replace redefined `C-h` binidng. Also remove the go up a directory behavior on backspace, now backspace is a regular backspace.
2015-09-27 14:17:30 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
helm-find-files: use C-h and C-l to go up down a directory Import TheBB configuration into Spacemacs and add `C-S-h` to replace redefined `C-h` binidng. Also remove the go up a directory behavior on backspace, now backspace is a regular backspace.
2015-09-27 14:17:30 +00:00
|-------------+-----------------------------------|
| ~C-h~ | go up one level (parent directory |
| ~C-H~ | describe key (replace ~C-h~) |
| ~C-j~ | go to previous candidate |
| ~C-k~ | go to next candidate |
| ~C-l~ | enter current directory |
[visual][popwin] add keybiding to resume last popwin buffer bind it to `spc r w`
2020-10-26 06:42:18 +00:00
**** Popup buffers
=popwin= is used to manage buffers such as ~*Help*~, ~*Completions*~,
~*compilation*~, and etc. Use =C-g= to close them or most of the time you can
close them with =q= also. Use ~SPC-r-w~ to view the last closed popup buffer.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
*** Ido
Doc: replace all occurences of =Spacemacs= by Spacemacs
2015-09-27 14:18:57 +00:00
Spacemacs displays the =ido= minibuffer vertically thanks to the
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
[[https://github.com/gempesaw/ido-vertical-mode.el][ido-vertical-mode]].
Basic =ido= operations can be done with ~Ctrl~ key:
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
|--------------------+---------------------------------------------------|
Use `RET` instead of `return` for return key It is an Emacs-wide convention to use `RET` when referring to the act of pressing the return key. Spacemacs seems to follow that convention as well. So fix some Org files that were deviating from this convention. In particular, replace usages of `<return>` and `return` with `RET`. Also update the description of an `M-RET` keybinding[1] based on the docstring of `ido-select-text`. [1]: Suggested-by: bmag <bmag@users.noreply.github.com>
2016-11-24 20:38:44 +00:00
| ~C-RET~ | open a =dired buffer= |
| ~M-RET~ | select the buffer or file named by the prompt |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
| ~C-d~ | delete selected file (ask for confirmation) |
| ~C-h~ | go to parent directory |
| ~C-j~ | select next file or directory |
| ~C-k~ | select previous file or directory |
| ~C-l~ | open the selected file |
| ~C-n~ | select next file or directory |
| ~C-o~ | open selected file in other window |
| ~C-p~ | select previous file or directory |
| ~C-s~ | open selected file in a vertically split window |
| ~C-t~ | open selected file in a new frame |
| ~C-v~ | open selected file in a horizontally split window |
| ~C-S-h~ | go to previous directory |
| ~C-S-j~ or ~C-S-n~ | next history element |
| ~C-S-k~ or ~C-S-p~ | previous history element |
| ~C-S-l~ | go to next directory |
Doc: transient-state => transient state
2016-03-21 02:08:49 +00:00
*** Ido transient state
Fix export-breaking org links in documentation As discussed in #8054 and #8136, org doesn't always export links correctly if the syntax deviates from the one given on the org mode website. This results in broken links on github and/or spacemacs.org as in #6722, #8036, #8054, #7956 and possibly others. This modifies all links not already fixed in #8136. Internal links are handled with Custom IDs. External file links are formatted according to org guidelines as well (see bottom), and if they point to a specific headline in an external file, a custom ID is created as well. Fixes #6722, #8036, #7956, #7916 as well as other unreported broken links. http://orgmode.org/manual/External-links.html#External-links http://orgmode.org/manual/Internal-links.html#Internal-links TODO: make Custom IDs invisble in space-org-mode
2017-01-09 12:11:54 +00:00
Spacemacs defines a [[#transient-states][transient state]] for =ido=.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Doc: transient-state => transient state
2016-03-21 02:08:49 +00:00
Initiate the transient state with ~M-SPC~ or ~s-M-SPC~ while in an =ido= buffer.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
|----------------------+---------------------------------------|
Doc: transient-state => transient state
2016-03-21 02:08:49 +00:00
| ~M-SPC~ or ~s-M-SPC~ | initiate or leave the transient state |
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
| ~?~ | display help |
| ~e~ | open dired |
| ~h~ | delete backward or parent directory |
| ~j~ | next match |
| ~J~ | sub directory |
| ~k~ | previous match |
| ~K~ | parent directory |
| ~l~ | select match |
| ~n~ | next directory in history |
| ~o~ | open in other window |
| ~p~ | previous directory in history |
Doc: transient-state => transient state
2016-03-21 02:08:49 +00:00
| ~q~ | quit transient state |
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
| ~s~ | open in a new horizontal split |
| ~t~ | open in other frame |
| ~v~ | open in a new vertical split |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
*** Bookmarks
Bookmarks can be set anywhere in a file. Bookmarks are persistent. They are very
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
useful to jump to/open a known project.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
Open the bookmark completion window by pressing= ~SPC f b~
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
|-------------+----------------------------------------------|
| ~C-d~ | delete the selected bookmark |
| ~C-e~ | edit the selected bookmark |
| ~C-f~ | toggle filename location |
| ~C-o~ | open the selected bookmark in another window |
To save a new bookmark, just type the name of the bookmark and press ~RET~.
*** DocView mode
=doc-view-mode= is a built-in major mode to view DVI, PostScript (PS), PDF,
OpenDocument, and Microsoft Office documents.
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
|-------------+------------------------------------------|
| ~/~ | search forward |
| ~?~ | search backward |
| ~+~ | enlarge |
| ~-~ | shrink |
| ~gg~ | go to first page |
| ~G~ | go to last page |
| ~gt~ | go to page number |
| ~h~ | previous page |
| ~H~ | adjust to height |
| ~j~ | next line |
| ~k~ | previous line |
| ~K~ | kill proc and buffer |
| ~l~ | next page |
| ~n~ | go to next search occurrence |
| ~N~ | go to previous search occurrence |
| ~P~ | fit page to window |
| ~r~ | revert |
| ~W~ | adjust to width |
| ~C-d~ | scroll down |
| ~C-k~ | kill proc |
| ~C-u~ | scroll up |
| ~C-c C-c~ | toggle display text and image display |
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
| ~C-c C-t~ | open new buffer with doc's text contents |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Refactor auto-save of files See committed documentation.
2015-06-19 03:54:07 +00:00
** Auto-saving
*** Frequency of auto-saving
By default auto-saving of files is performed every 300 characters and
every 30 seconds of idle time which can be changed by setting to a
Simple misspelling typos...
2016-10-29 22:13:48 +00:00
new value the variables =auto-save-interval= and =auto-save-timeout=
Refactor auto-save of files See committed documentation.
2015-06-19 03:54:07 +00:00
respectively.
*** Location of auto-saved files
Auto-save of modified files can be performed in-place on the original file
itself /or/ in the cache directory (in this case the original file will remain
unsaved). By default Spacemacs auto-save the file in the cache directory.
To modify the location set the variable =dotspacemacs-auto-save-file-location=
to =original= or =cache=.
Local files are auto-saved in a sub-directory called =site= in the =cache=
Minor modification in documentation
2015-06-19 04:08:59 +00:00
directory whereas remote files (i.e. files edited over TRAMP) are auto-saved
in a sub-directory called =dist=.
Refactor auto-save of files See committed documentation.
2015-06-19 03:54:07 +00:00
*** Disable auto-save
To disable auto-saving set the variable =dotspacemacs-auto-save-file-location=
to =nil=.
You can toggle auto-save in a buffer by calling the command =auto-save-mode=.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
** Searching
*** With an external tool
Doc: replace all occurences of =Spacemacs= by Spacemacs
2015-09-27 14:18:57 +00:00
Spacemacs can be interfaced with different search utilities like:
Reformat documentation
2018-09-19 03:54:47 +00:00
- [[https://github.com/BurntSushi/ripgrep][rg]]
- [[https://github.com/ggreer/the_silver_searcher][ag]]
- [[https://github.com/monochromegane/the_platinum_searcher][pt]]
- [[https://beyondgrep.com/][ack]]
- grep
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Update .spacemacs function names in DOCUMENTATION.org. dotspacemacs/init -> dotspacemacs/user-init dotspacemacs/config -> dotspacemacs/user-config
2015-09-05 07:55:28 +00:00
The search commands in Spacemacs are organized under the ~SPC s~ prefix with the
Documentation fixes. Fixes: - Typo - Code block indentation - Put keybindings on one line so they look nicer when viewed in Spacemacs - Make one sentence sound better
2017-04-18 06:05:28 +00:00
next key is the tool to use and the last key is the scope. For instance
~SPC s a b~ will search in all opened buffers using =ag=.
Update .spacemacs function names in DOCUMENTATION.org. dotspacemacs/init -> dotspacemacs/user-init dotspacemacs/config -> dotspacemacs/user-config
2015-09-05 07:55:28 +00:00
If the last key (determining the scope) is uppercase then the current region or
Documentation fixes. Fixes: - Typo - Code block indentation - Put keybindings on one line so they look nicer when viewed in Spacemacs - Make one sentence sound better
2017-04-18 06:05:28 +00:00
symbol under point is used as default input for the search. For instance
~SPC s a B~ will search with symbol under point (if there is no active region).
Update .spacemacs function names in DOCUMENTATION.org. dotspacemacs/init -> dotspacemacs/user-init dotspacemacs/config -> dotspacemacs/user-config
2015-09-05 07:55:28 +00:00
If the tool key is omitted then a default tool will be automatically selected
for the search. This tool corresponds to the first tool found on the system of
Add ripgrep support * Add rg to helm completion layer * Add rg to ivy layer * Prepend rg to dotspacemacs-search-tools * Add rg to documentation
2016-10-20 00:29:06 +00:00
the list =dotspacemacs-search-tools=, the default order is =rg=, =ag=, =pt=,
=ack= then =grep=. For instance ~SPC s b~ will search in the opened buffers
using =pt= if =rg= and =ag= have not been found on the system.
New key bindings scheme for searching See commit content for documentation
2015-06-16 02:53:59 +00:00
The tool keys are:
| Tool | Key |
|------+-----|
| ag | a |
| grep | g |
| ack | k |
Add ripgrep support * Add rg to helm completion layer * Add rg to ivy layer * Prepend rg to dotspacemacs-search-tools * Add rg to documentation
2016-10-20 00:29:06 +00:00
| rg | r |
New key bindings scheme for searching See commit content for documentation
2015-06-16 02:53:59 +00:00
| pt | t |
The available scopes and corresponding keys are:
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
| Scope | Key |
|----------------------------+-----|
| opened buffers | b |
| files in a given directory | f |
| current project | p |
New key bindings scheme for searching See commit content for documentation
2015-06-16 02:53:59 +00:00
It is possible to search in the current file by double tapping the second key
of the sequence, for instance ~SPC s a a~ will search in the current
file with =ag=.
Consitently format Note: lines in DOCUMENTATION.org. Format is: *Note*: note here
2015-09-05 07:57:50 +00:00
*Notes*:
Add ripgrep support * Add rg to helm completion layer * Add rg to ivy layer * Prepend rg to dotspacemacs-search-tools * Add rg to documentation
2016-10-20 00:29:06 +00:00
- =rg=, =ag= and =pt= are optimized to be used in a source control repository but
New key bindings scheme for searching See commit content for documentation
2015-06-16 02:53:59 +00:00
they can be used in an arbitrary directory as well.
- It is also possible to search in several directories at once by marking
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
them in the Helm buffer (not available in Ivy).
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
fix links
2019-05-18 10:21:28 +00:00
*Beware* if you use =pt=, [[https://core.tcl.tk/tcllib/doc/tcllib-1-17/embedded/www/tcllib/files/apps/pt.html][TCL parser tools]] also install a command line tool
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
called =pt=.
New key bindings scheme for searching See commit content for documentation
2015-06-16 02:53:59 +00:00
**** Useful key bindings
Format documenation files with doc-fmt tool
2016-04-13 03:31:38 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
|------------------------+--------------------------------------------------------------|
| ~F3~ | in a completion buffer, save results to a regular buffer |
| ~SPC r l~ | resume the last =completion= buffer |
| ~SPC r s~ or ~SPC s l~ | resume search buffer (completion or converted search buffer) |
| ~SPC s `~ | go back to the previous place before jump |
| Prefix argument | will ask for file extensions |
Update documentation
2016-06-08 18:26:35 +00:00
When results have been saved in a regular buffer with ~F3~, that buffer supports
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
browsing through the matches with Spacemacs' =next-error= and =previous-error=
Add 'z' recenter bindings for various transient states By analogy with the "zz", "zb", "zt" vim / evil bindings, this adds an additional key binding "z" for `recenter-top-bottom` to the following transient states which navigate around the buffer in large jumps: - auto-symbol-highlight - error - buffer - vcs - org-babel This allows for repositioning of the buffer for visibility without having to exit the transient state. Minor updates are also made to documentation of other transient states.
2018-10-22 08:09:55 +00:00
bindings (~SPC e n~ and ~SPC e p~) as well as the error transient state (~SPC e .~).
Update search docs for new scope-based search commands
2015-06-15 13:05:26 +00:00
[Fix #1953] Correct link to text micro-state documentation.
2015-06-24 05:49:00 +00:00
**** Searching in current file
Format documenation files with doc-fmt tool
2016-04-13 03:31:38 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
New key bindings scheme for searching See commit content for documentation
2015-06-16 02:53:59 +00:00
|-------------+-----------------------------------------------------|
| ~SPC s s~ | search with the first found tool |
| ~SPC s S~ | search with the first found tool with default input |
| ~SPC s a a~ | =ag= |
| ~SPC s a A~ | =ag= with default input |
| ~SPC s g g~ | =grep= |
| ~SPC s g G~ | =grep= with default input |
Add ripgrep support * Add rg to helm completion layer * Add rg to ivy layer * Prepend rg to dotspacemacs-search-tools * Add rg to documentation
2016-10-20 00:29:06 +00:00
| ~SPC s r r~ | =rg= |
| ~SPC s r R~ | =rg= with default input |
Update search docs for new scope-based search commands
2015-06-15 13:05:26 +00:00
**** Searching in all open buffers visiting files
Format documenation files with doc-fmt tool
2016-04-13 03:31:38 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
New key bindings scheme for searching See commit content for documentation
2015-06-16 02:53:59 +00:00
|-------------+-----------------------------------------------------|
| ~SPC s b~ | search with the first found tool |
| ~SPC s B~ | search with the first found tool with default input |
| ~SPC s a b~ | =ag= |
| ~SPC s a B~ | =ag= with default text |
| ~SPC s g b~ | =grep= |
| ~SPC s g B~ | =grep= with default text |
| ~SPC s k b~ | =ack= |
| ~SPC s k B~ | =ack= with default text |
Add ripgrep support * Add rg to helm completion layer * Add rg to ivy layer * Prepend rg to dotspacemacs-search-tools * Add rg to documentation
2016-10-20 00:29:06 +00:00
| ~SPC s r b~ | =rg= |
| ~SPC s r B~ | =rg= with default text |
New key bindings scheme for searching See commit content for documentation
2015-06-16 02:53:59 +00:00
| ~SPC s t b~ | =pt= |
| ~SPC s t B~ | =pt= with default text |
Doc typo: "search for files" -> "search in files" "Search for files" means that the command looks for files, while actually `SPC s f` searches in some files for lines that match the given search pattern. Changed it to "search in files" to better reflect what the command does.
2015-10-07 07:47:34 +00:00
**** Searching in files in an arbitrary directory
Format documenation files with doc-fmt tool
2016-04-13 03:31:38 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
New key bindings scheme for searching See commit content for documentation
2015-06-16 02:53:59 +00:00
|-------------+-----------------------------------------------------|
| ~SPC s f~ | search with the first found tool |
| ~SPC s F~ | search with the first found tool with default input |
| ~SPC s a f~ | =ag= |
| ~SPC s a F~ | =ag= with default text |
| ~SPC s g f~ | =grep= |
| ~SPC s g F~ | =grep= with default text |
| ~SPC s k f~ | =ack= |
| ~SPC s k F~ | =ack= with default text |
Add ripgrep support * Add rg to helm completion layer * Add rg to ivy layer * Prepend rg to dotspacemacs-search-tools * Add rg to documentation
2016-10-20 00:29:06 +00:00
| ~SPC s r f~ | =rg= |
| ~SPC s r F~ | =rg= with default text |
New key bindings scheme for searching See commit content for documentation
2015-06-16 02:53:59 +00:00
| ~SPC s t f~ | =pt= |
| ~SPC s t F~ | =pt= with default text |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Implement helm-dir-search This is equivalent to helm-file-search with the current directory as the scope
2017-06-19 19:17:12 +00:00
**** Searching in current directory
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Reformat documentation
2018-09-19 03:54:47 +00:00
|----------------------+-----------------------------------------------------|
| ~SPC /~ or ~SPC s d~ | search with the first found tool |
| ~SPC *~ or ~SPC s D~ | search with the first found tool with default input |
| ~SPC s a d~ | =ag= |
| ~SPC s a D~ | =ag= with default text |
| ~SPC s g d~ | =grep= with default text |
| ~SPC s k d~ | =ack= |
| ~SPC s k D~ | =ack= with default text |
| ~SPC s t d~ | =pt= |
| ~SPC s t D~ | =pt= with default text |
| ~SPC s r d~ | =rg= |
| ~SPC s r D~ | =rg= with default text |
Implement helm-dir-search This is equivalent to helm-file-search with the current directory as the scope
2017-06-19 19:17:12 +00:00
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
**** Searching in a project
Format and cleanup docs. Fix links.
2017-04-25 15:42:58 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Reformat documentation
2018-09-19 03:54:47 +00:00
|----------------------+-----------------------------------------------------|
| ~SPC /~ or ~SPC s p~ | search with the first found tool |
| ~SPC *~ or ~SPC s P~ | search with the first found tool with default input |
| ~SPC s a p~ | =ag= |
| ~SPC s a P~ | =ag= with default text |
| ~SPC s g p~ | =grep= with default text |
| ~SPC s k p~ | =ack= |
| ~SPC s k P~ | =ack= with default text |
| ~SPC s t p~ | =pt= |
| ~SPC s t P~ | =pt= with default text |
| ~SPC s r p~ | =rg= |
| ~SPC s r P~ | =rg= with default text |
Update search docs for new scope-based search commands
2015-06-15 13:05:26 +00:00
doc: add hint for `C-s` in `SPC p p` helm buffer
2015-10-19 04:19:30 +00:00
*Hint*: It is also possible to search in a project without needing to open a
file beforehand. To do so use ~SPC p p~ and then ~C-s~ on a given project to
directly search into it like with ~SPC s p~.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
**** Searching the web
Format documenation files with doc-fmt tool
2016-04-13 03:31:38 +00:00
documentation formatting: Thu Apr 4 16:29:54 UTC 2019
2019-04-04 16:29:54 +00:00
| Key binding | Description |
|-------------+-------------------------------------------------------------------|
| ~SPC s w g~ | Get Google suggestions in emacs. Opens Google results in Browser. |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
*** Persistent highlighting
Doc: replace all occurences of =Spacemacs= by Spacemacs
2015-09-27 14:18:57 +00:00
Spacemacs uses =evil-search-highlight-persist= to keep the searched expression
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
highlighted until the next search. It is also possible to clear the highlighting
by pressing ~SPC s c~ or executing the ex command =:noh=.
*** Highlight current symbol
Doc: replace all occurences of =Spacemacs= by Spacemacs
2015-09-27 14:18:57 +00:00
Spacemacs supports highlighting of the current symbol on demand (provided by
Doc: transient-state => transient state
2016-03-21 02:08:49 +00:00
[[https://github.com/emacsmirror/auto-highlight-symbol][auto-highlight-symbol]] mode) and adds a transient state to easily navigate and rename
Format paragraphs/code/tables in DOCUMENTATION.org.
2015-09-05 08:03:36 +00:00
this symbol.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
It is also possible to change the range of the navigation on the fly to:
Reformat documentation
2018-09-19 03:54:47 +00:00
- buffer
- function
- visible area
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
To initiate the highlighting of the current symbol under point press ~SPC s h~.
Navigation between the highlighted symbols can be done with the commands:
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Update automatic highlight of symbol toggle
2015-09-29 02:12:08 +00:00
|-------------+------------------------------------------------------------------------------------|
Correct key binding
2016-07-10 17:51:49 +00:00
| ~*~ | initiate navigation transient state on current symbol and jump forwards |
Doc: transient-state => transient state
2016-03-21 02:08:49 +00:00
| ~#~ | initiate navigation transient state on current symbol and jump backwards |
Update automatic highlight of symbol toggle
2015-09-29 02:12:08 +00:00
| ~SPC s e~ | edit all occurrences of the current symbol(/) |
| ~SPC s h~ | highlight the current symbol and all its occurrence within the current range |
| ~SPC s H~ | go to the last searched occurrence of the last highlighted symbol |
| ~SPC t h a~ | toggle automatic highlight of symbol under point after =ahs-idle-interval= seconds |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Add 'z' recenter bindings for various transient states By analogy with the "zz", "zb", "zt" vim / evil bindings, this adds an additional key binding "z" for `recenter-top-bottom` to the following transient states which navigate around the buffer in large jumps: - auto-symbol-highlight - error - buffer - vcs - org-babel This allows for repositioning of the buffer for visibility without having to exit the transient state. Minor updates are also made to documentation of other transient states.
2018-10-22 08:09:55 +00:00
During the symbol highlight transient state, the following bindings are active:
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Add 'z' recenter bindings for various transient states By analogy with the "zz", "zb", "zt" vim / evil bindings, this adds an additional key binding "z" for `recenter-top-bottom` to the following transient states which navigate around the buffer in large jumps: - auto-symbol-highlight - error - buffer - vcs - org-babel This allows for repositioning of the buffer for visibility without having to exit the transient state. Minor updates are also made to documentation of other transient states.
2018-10-22 08:09:55 +00:00
|-------------+---------------------------------------------------------------|
| ~e~ | edit occurrences (*) |
| ~n~ | go to next occurrence |
| ~N~ or ~p~ | go to previous occurrence |
| ~d~ | go to next definition occurrence |
| ~D~ | go to previous definition occurrence |
| ~r~ | change range (=function=, =display area=, =whole buffer=) |
| ~R~ | go to home occurrence (reset position to starting occurrence) |
| ~s~ | search current buffer for symbol using ivy / helm |
| ~b~ | search all open buffers for symbol using ivy / helm |
| ~f~ | search files for symbol |
| ~/~ | search current project for symbol |
| ~z~ | recenter buffer in window |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Add 'z' recenter bindings for various transient states By analogy with the "zz", "zb", "zt" vim / evil bindings, this adds an additional key binding "z" for `recenter-top-bottom` to the following transient states which navigate around the buffer in large jumps: - auto-symbol-highlight - error - buffer - vcs - org-babel This allows for repositioning of the buffer for visibility without having to exit the transient state. Minor updates are also made to documentation of other transient states.
2018-10-22 08:09:55 +00:00
(*) using [[https://github.com/tsdh/iedit][iedit]] or the default implementation of =auto-highlight-symbol=
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Add 'z' recenter bindings for various transient states By analogy with the "zz", "zb", "zt" vim / evil bindings, this adds an additional key binding "z" for `recenter-top-bottom` to the following transient states which navigate around the buffer in large jumps: - auto-symbol-highlight - error - buffer - vcs - org-babel This allows for repositioning of the buffer for visibility without having to exit the transient state. Minor updates are also made to documentation of other transient states.
2018-10-22 08:09:55 +00:00
The minibuffer displays the following information during the transient state:
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
#+BEGIN_EXAMPLE
Add 'z' recenter bindings for various transient states By analogy with the "zz", "zb", "zt" vim / evil bindings, this adds an additional key binding "z" for `recenter-top-bottom` to the following transient states which navigate around the buffer in large jumps: - auto-symbol-highlight - error - buffer - vcs - org-babel This allows for repositioning of the buffer for visibility without having to exit the transient state. Minor updates are also made to documentation of other transient states.
2018-10-22 08:09:55 +00:00
Buffer [6/11]*
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
#+END_EXAMPLE
Add 'z' recenter bindings for various transient states By analogy with the "zz", "zb", "zt" vim / evil bindings, this adds an additional key binding "z" for `recenter-top-bottom` to the following transient states which navigate around the buffer in large jumps: - auto-symbol-highlight - error - buffer - vcs - org-babel This allows for repositioning of the buffer for visibility without having to exit the transient state. Minor updates are also made to documentation of other transient states.
2018-10-22 08:09:55 +00:00
Where =M [x/y]*= indicates:
- =M=: the current search scope, which is one of the following:
- =Buffer=: whole buffer range
- =Display=: current display range
- =Function=: current function range (dependent on the programming language major mode)
Reformat documentation
2018-09-19 03:54:47 +00:00
- =x=: the index of the current highlighted occurrence
- =y=: the total number of occurrences
- =*=: appears if there is at least one occurrence which is not currently visible.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
*** Visual Star
With [[https://github.com/bling/evil-visualstar][evil-visualstar]] you can search for the next occurrence of the current
selection.
Fix export-breaking org links in documentation As discussed in #8054 and #8136, org doesn't always export links correctly if the syntax deviates from the one given on the org mode website. This results in broken links on github and/or spacemacs.org as in #6722, #8036, #8054, #7956 and possibly others. This modifies all links not already fixed in #8136. Internal links are handled with Custom IDs. External file links are formatted according to org guidelines as well (see bottom), and if they point to a specific headline in an external file, a custom ID is created as well. Fixes #6722, #8036, #7956, #7916 as well as other unreported broken links. http://orgmode.org/manual/External-links.html#External-links http://orgmode.org/manual/Internal-links.html#Internal-links TODO: make Custom IDs invisble in space-org-mode
2017-01-09 12:11:54 +00:00
It is pretty useful combined with the [[#expand-region][expand-region]] bindings.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Markup fixes This makes all Notes in DOCUMENTATION.org be *Note*: and changes the markup around the spacemacs init file path in jabbers README.org to proper org markup.
2015-10-13 11:41:48 +00:00
*Note*: If the current state is not the =visual state= then pressing ~*~ uses
Doc: transient-state => transient state
2016-03-21 02:08:49 +00:00
auto-highlight-symbol and its transient state.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
*** Listing symbols by semantic
Update documentation to remove explicit mentions to helm Move some helm explicit sections the helm layer README.
2017-04-16 15:10:26 +00:00
To list all the symbols of a buffer press ~SPC s j~
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
** Editing
*** Paste text
Update transient state wording, etc. - Removed the word `Manipulation` from the transient state titles: - Buffer Manipulation Transient State and Window Manipulation TS - Expanded the TS abbreviation to Transient State - Documented the Buffer Transient State key binding: `q` to quit the transient state - Capitalized `Transient State` in the titles - Window Transient State: - Added a line break after the title in the folded hint. This allows for more keys to be visible horizontally. - Moved up the [?] help key after the title, so that it's in the same place in both the folded and full transient state.
2019-11-06 19:14:34 +00:00
**** Paste transient state
Spacemacs documentation improvements `SPC f e f` key binding is no more present, so moved that table entry to `SPC h f` in DOCUMENTATION.org. corrected description of paste transient-state behavior.
2018-07-05 15:57:52 +00:00
The paste transient state can be enabled by setting the variable
Change all references of micro-state in codebase to transient-state
2016-01-30 11:32:53 +00:00
=dotspacemacs-enable-paste-transient-state= to =t=. By default it is disabled.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Spacemacs documentation improvements `SPC f e f` key binding is no more present, so moved that table entry to `SPC h f` in DOCUMENTATION.org. corrected description of paste transient-state behavior.
2018-07-05 15:57:52 +00:00
When the transient state is enabled, after you paste something, pressing ~C-j~
or ~C-k~ will replace the pasted text with the previous or next yanked (copied)
text on the kill ring.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
For example if you copy =foo= and =bar= then press ~p~ the text =bar= will
Spacemacs documentation improvements `SPC f e f` key binding is no more present, so moved that table entry to `SPC h f` in DOCUMENTATION.org. corrected description of paste transient-state behavior.
2018-07-05 15:57:52 +00:00
be pasted, pressing ~C-j~ will replace =bar= with =foo=.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Add 'z' recenter bindings for various transient states By analogy with the "zz", "zb", "zt" vim / evil bindings, this adds an additional key binding "z" for `recenter-top-bottom` to the following transient states which navigate around the buffer in large jumps: - auto-symbol-highlight - error - buffer - vcs - org-babel This allows for repositioning of the buffer for visibility without having to exit the transient state. Minor updates are also made to documentation of other transient states.
2018-10-22 08:09:55 +00:00
|-------------+-------------------------------------------------------------------------------|
| ~p~ or ~P~ | paste the text before or after point and initiate the =paste= transient state |
| ~C-j~ | in transient state: replace paste text with the previously copied one |
| ~C-k~ | in transient state: replace paste text with the next copied one |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
**** Auto-indent pasted text
By default any pasted text will be auto-indented. To paste text un-indented use
the universal argument.
It is possible to disable the auto-indentation for specific major-modes by
adding a major-mode to the variable =spacemacs-indent-sensitive-modes= in your
Update .spacemacs function names in DOCUMENTATION.org. dotspacemacs/init -> dotspacemacs/user-init dotspacemacs/config -> dotspacemacs/user-config
2015-09-05 07:55:28 +00:00
=dotspacemacs/user-config= function.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
*** Text manipulation commands
Text related commands (start with ~x~):
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Add key binding SPC d w SPC for built-in commnand just-one-space
2017-04-23 17:01:34 +00:00
|---------------+---------------------------------------------------------------|
Replace move-text with drag-stuff Just like: https://github.com/emacsfodder/move-text https://github.com/rejeep/drag-stuff.el also drags one or more (region) lines up or down. But it also allows for dragging left and right (across end of lines): - a word: changing place with the next or previous word. - a region: moving it one character at a time to the left or right. Added a new key binding: `SPC x .` that opens the: ``` Drag Stuff Transient State [k/K] up [h/H] left [q] quit [j/J] down [l/L] right ``` The `move-text` package isn't removed, even though it isn't used anymore in Spacemacs. Because the `evil-unimpaired` elpa directory is generated from the local Spacemacs `evil-unimpaired.el` file. https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Bspacemacs/spacemacs-evil/local/evil-unimpaired/evil-unimpaired.el Therefore the `evil-unimpaired` key bindings `[e` and `]e` still call the `move-text` commands. Until the `evil-unimpaired` elpa directory has been removed and regenerated by restarting Spacemacs. Then they will call the new `drag-stuff` commands. I don't know if/when the `move-text` package can be removed in the future.
2021-03-02 16:07:57 +00:00
| ~SPC x .~ | enter the drag stuff transient state |
[editing] Document key binding ~SPC x y~ and sort them
2019-05-12 14:59:57 +00:00
| ~SPC x TAB~ | indent or dedent a region rigidly |
Add key binding SPC d w SPC for built-in commnand just-one-space
2017-04-23 17:01:34 +00:00
| ~SPC x a &~ | align region at & |
| ~SPC x a (~ | align region at ( |
| ~SPC x a )~ | align region at ) |
| ~SPC x a [~ | align region at [ |
| ~SPC x a ]~ | align region at ] |
| ~SPC x a {~ | align region at { |
| ~SPC x a }~ | align region at } |
| ~SPC x a ​,​~ | align region at , |
| ~SPC x a .~ | align region at . (for numeric tables) |
| ~SPC x a :~ | align region at : |
| ~SPC x a ;~ | align region at ; |
| ~SPC x a =~ | align region at = |
| ~SPC x a a~ | align region (or guessed section) using default rules |
| ~SPC x a c~ | align current indentation region using default rules |
Modify evil-lion config - Adjust keys not to collide with evil-little-word - Add documentation
2017-05-23 09:08:06 +00:00
| ~SPC x a l~ | left-align with evil-lion |
| ~SPC x a L~ | right-align with evil-lion |
Add key binding SPC d w SPC for built-in commnand just-one-space
2017-04-23 17:01:34 +00:00
| ~SPC x a r~ | align region using user-specified regexp |
| ~SPC x a m~ | align region at arithmetic operators (+-*/) |
| ~SPC x a ¦~ | align region at ¦ |
[editing] Add missing documentation and make string-edit lazy load
2021-02-28 20:54:52 +00:00
| ~SPC x A~ | Open all visible links |
Add key binding SPC d w SPC for built-in commnand just-one-space
2017-04-23 17:01:34 +00:00
| ~SPC x c~ | count the number of chars/words/lines in the selection region |
[doc] Add documentation for SPC x d l
2020-02-01 15:13:12 +00:00
| ~SPC x d l~ | delete blank lines but one or the single blank line |
Add key binding SPC d w SPC for built-in commnand just-one-space
2017-04-23 17:01:34 +00:00
| ~SPC x d w~ | delete trailing whitespaces |
| ~SPC x d SPC~ | Delete all spaces and tabs around point, leaving one space |
[editing] Add missing documentation and make string-edit lazy load
2021-02-28 20:54:52 +00:00
| ~SPC x e~ | Edit strings in place |
Add key binding SPC d w SPC for built-in commnand just-one-space
2017-04-23 17:01:34 +00:00
| ~SPC x g l~ | set languages used by translate commands |
| ~SPC x g t~ | translate current word using Google Translate |
| ~SPC x g T~ | reverse source and target languages |
string-inflection: group which-keys, sort code/doc Group together the which-key entries that call the same command: k and - becomes k,- u and _ becomes u,_ Declare a prefix name for SPC x i, this changes the SPC x entry: from: "i -> +prefix" to: "i -> +inflection". Capitalize the transient state title, so that it matches the other TS titles. Sort the code and documentation key bindings alphabetically.
2017-06-09 17:54:41 +00:00
| ~SPC x i c~ | change symbol style to =lowerCamelCase= |
| ~SPC x i C~ | change symbol style to =UpperCamelCase= |
string-inflection: transient state for cycling
2017-06-10 14:31:05 +00:00
| ~SPC x i i~ | cycle symbol naming styles (~i~ to keep cycling) |
string-inflection: group which-keys, sort code/doc Group together the which-key entries that call the same command: k and - becomes k,- u and _ becomes u,_ Declare a prefix name for SPC x i, this changes the SPC x entry: from: "i -> +prefix" to: "i -> +inflection". Capitalize the transient state title, so that it matches the other TS titles. Sort the code and documentation key bindings alphabetically.
2017-06-09 17:54:41 +00:00
| ~SPC x i -~ | change symbol style to =kebab-case= |
| ~SPC x i k~ | change symbol style to =kebab-case= |
doc: code, not keys
2017-06-10 14:32:18 +00:00
| ~SPC x i _~ | change symbol style to =under_score= |
string-inflection: group which-keys, sort code/doc Group together the which-key entries that call the same command: k and - becomes k,- u and _ becomes u,_ Declare a prefix name for SPC x i, this changes the SPC x entry: from: "i -> +prefix" to: "i -> +inflection". Capitalize the transient state title, so that it matches the other TS titles. Sort the code and documentation key bindings alphabetically.
2017-06-09 17:54:41 +00:00
| ~SPC x i u~ | change symbol style to =under_score= |
doc: code, not keys
2017-06-10 14:32:18 +00:00
| ~SPC x i U~ | change symbol style to =UP_CASE= |
Add key binding SPC d w SPC for built-in commnand just-one-space
2017-04-23 17:01:34 +00:00
| ~SPC x j c~ | set the justification to center |
| ~SPC x j f~ | set the justification to full |
| ~SPC x j l~ | set the justification to left |
| ~SPC x j n~ | set the justification to none |
| ~SPC x j r~ | set the justification to right |
Replace move-text with drag-stuff Just like: https://github.com/emacsfodder/move-text https://github.com/rejeep/drag-stuff.el also drags one or more (region) lines up or down. But it also allows for dragging left and right (across end of lines): - a word: changing place with the next or previous word. - a region: moving it one character at a time to the left or right. Added a new key binding: `SPC x .` that opens the: ``` Drag Stuff Transient State [k/K] up [h/H] left [q] quit [j/J] down [l/L] right ``` The `move-text` package isn't removed, even though it isn't used anymore in Spacemacs. Because the `evil-unimpaired` elpa directory is generated from the local Spacemacs `evil-unimpaired.el` file. https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Bspacemacs/spacemacs-evil/local/evil-unimpaired/evil-unimpaired.el Therefore the `evil-unimpaired` key bindings `[e` and `]e` still call the `move-text` commands. Until the `evil-unimpaired` elpa directory has been removed and regenerated by restarting Spacemacs. Then they will call the new `drag-stuff` commands. I don't know if/when the `move-text` package can be removed in the future.
2021-03-02 16:07:57 +00:00
| ~SPC x J~ | drag down a line of text (enter drag stuff transient state) |
| ~SPC x K~ | drag up a line of text (enter drag stuff transient state) |
Add key binding SPC d w SPC for built-in commnand just-one-space
2017-04-23 17:01:34 +00:00
| ~SPC x l d~ | duplicate line or region |
Add key bindings to randomize word and lines in region
2019-11-20 16:31:23 +00:00
| ~SPC x l r~ | randomize lines in region |
Add key binding SPC d w SPC for built-in commnand just-one-space
2017-04-23 17:01:34 +00:00
| ~SPC x l s~ | sort lines |
| ~SPC x l u~ | uniquify lines |
| ~SPC x o~ | use avy to select a link in the frame and open it |
| ~SPC x O~ | use avy to select multiple links in the frame and open them |
| ~SPC x t c~ | swap (transpose) the current character with the previous one |
add keybinding to documentation
2018-06-02 15:06:11 +00:00
| ~SPC x t e~ | swap (transpose) the current sexp with the previous one |
Add key binding SPC d w SPC for built-in commnand just-one-space
2017-04-23 17:01:34 +00:00
| ~SPC x t l~ | swap (transpose) the current line with the previous one |
sort transpose functions and update documentation
2017-07-26 10:36:02 +00:00
| ~SPC x t p~ | swap (transpose) the current paragraph with the previous one |
| ~SPC x t s~ | swap (transpose) the current sentence with the previous one |
| ~SPC x t w~ | swap (transpose) the current word with the previous one |
Add key binding SPC d w SPC for built-in commnand just-one-space
2017-04-23 17:01:34 +00:00
| ~SPC x u~ | set the selected text to lower case |
| ~SPC x U~ | set the selected text to upper case |
| ~SPC x w c~ | count the number of occurrences per word in the select region |
| ~SPC x w d~ | show dictionary entry of word from wordnik.com |
Add key bindings to randomize word and lines in region
2019-11-20 16:31:23 +00:00
| ~SPC x w r~ | randomize words in region |
[editing] Document key binding ~SPC x y~ and sort them
2019-05-12 14:59:57 +00:00
| ~SPC x y~ | use avy to copy a link in the frame |
[editing] Add missing documentation and make string-edit lazy load
2021-02-28 20:54:52 +00:00
| ~SPC x Y~ | use avy to copy multiple links in the frame |
Move lorem ipsum package to il Spacemacs already has the "i" prefix for insertion, why do we also need a separate prefix "xi" for “text insertion”?
2015-11-13 17:17:15 +00:00
Replace move-text with drag-stuff Just like: https://github.com/emacsfodder/move-text https://github.com/rejeep/drag-stuff.el also drags one or more (region) lines up or down. But it also allows for dragging left and right (across end of lines): - a word: changing place with the next or previous word. - a region: moving it one character at a time to the left or right. Added a new key binding: `SPC x .` that opens the: ``` Drag Stuff Transient State [k/K] up [h/H] left [q] quit [j/J] down [l/L] right ``` The `move-text` package isn't removed, even though it isn't used anymore in Spacemacs. Because the `evil-unimpaired` elpa directory is generated from the local Spacemacs `evil-unimpaired.el` file. https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Bspacemacs/spacemacs-evil/local/evil-unimpaired/evil-unimpaired.el Therefore the `evil-unimpaired` key bindings `[e` and `]e` still call the `move-text` commands. Until the `evil-unimpaired` elpa directory has been removed and regenerated by restarting Spacemacs. Then they will call the new `drag-stuff` commands. I don't know if/when the `move-text` package can be removed in the future.
2021-03-02 16:07:57 +00:00
**** Drag stuff transient state
The drag stuff transient state is opened with ~SPC x .~:
[bot] Auto-update (#14398) * documentation formatting: Sat Mar 13 23:53:10 UTC 2021 * Built-in files auto-update: Sat Mar 13 23:51:34 UTC 2021
2021-03-13 23:57:56 +00:00
| Key binding | Description |
|-------------------+-----------------------------|
| ~k~, ~K~, ~Up~ | drag up |
| ~j~, ~J~, ~Down~ | drag down |
| ~h~, ~H~, ~Left~ | drag left (word or region) |
| ~l~, ~L~, ~Right~ | drag right (word or region) |
| ~q~ | quit transient state |
Replace move-text with drag-stuff Just like: https://github.com/emacsfodder/move-text https://github.com/rejeep/drag-stuff.el also drags one or more (region) lines up or down. But it also allows for dragging left and right (across end of lines): - a word: changing place with the next or previous word. - a region: moving it one character at a time to the left or right. Added a new key binding: `SPC x .` that opens the: ``` Drag Stuff Transient State [k/K] up [h/H] left [q] quit [j/J] down [l/L] right ``` The `move-text` package isn't removed, even though it isn't used anymore in Spacemacs. Because the `evil-unimpaired` elpa directory is generated from the local Spacemacs `evil-unimpaired.el` file. https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Bspacemacs/spacemacs-evil/local/evil-unimpaired/evil-unimpaired.el Therefore the `evil-unimpaired` key bindings `[e` and `]e` still call the `move-text` commands. Until the `evil-unimpaired` elpa directory has been removed and regenerated by restarting Spacemacs. Then they will call the new `drag-stuff` commands. I don't know if/when the `move-text` package can be removed in the future.
2021-03-02 16:07:57 +00:00
Move lorem ipsum package to il Spacemacs already has the "i" prefix for insertion, why do we also need a separate prefix "xi" for “text insertion”?
2015-11-13 17:17:15 +00:00
*** Text insertion commands
Text insertion commands (start with ~i~):
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
| Key binding | Description |
|-------------+-----------------------------------------------------------------------|
| ~SPC i l l~ | insert lorem-ipsum list |
| ~SPC i l p~ | insert lorem-ipsum paragraph |
| ~SPC i l s~ | insert lorem-ipsum sentence |
Add password-generator package under SPC i p
2017-05-19 03:02:08 +00:00
| ~SPC i p 1~ | insert simple password |
| ~SPC i p 2~ | insert stronger password |
| ~SPC i p 3~ | insert password for paranoids |
| ~SPC i p p~ | insert a phonetically easy password |
| ~SPC i p n~ | insert a numerical password |
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
| ~SPC i u~ | Search for Unicode characters and insert them into the active buffer. |
| ~SPC i U 1~ | insert UUIDv1 (use universal argument to insert with CID format) |
| ~SPC i U 4~ | insert UUIDv4 (use universal argument to insert with CID format) |
| ~SPC i U U~ | insert UUIDv4 (use universal argument to insert with CID format) |
Add unicode to core spacemacs layer with SPC i u which stands for 'insert unicode' and document it
2015-07-22 03:04:05 +00:00
Add password-generator package under SPC i p
2017-05-19 03:02:08 +00:00
*Hint:* You can change the length of the inserted password with a numerical
[doc] Remove unneeded SPC U for numerical prefix argument
2019-11-20 16:35:33 +00:00
prefix argument, for instance ~24 SPC i p p~ will insert a password
Add password-generator package under SPC i p
2017-05-19 03:02:08 +00:00
with 24 characters.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
*** Smartparens Strict mode
[[https://github.com/Fuco1/smartparens][Smartparens]] comes with a strict mode which prevents deletion of parenthesis if
the result is unbalanced.
This mode can be frustrating for novices, this is why it is not enabled by
default.
It is possible to enable it easily for /all programming modes/ with the variable
=dotspacemacs-smartparens-strict-mode= of you =~/.spacemacs=.
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(setq-default dotspacemacs-smartparens-strict-mode t)
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
*** Zooming
**** Text
The font size of the current buffer can be adjusted with the commands:
Add j and k to transient states It is nicer when user can stay in the "home row" for basic operations like zooming in and out Font Scaling Transient State `k` scale up `j` scale down Frame Transparency Transient State `k` increase transparency `j` decrease transparency Zoom Frame Transient State `k` zoom frame in `j` zoom frame out Added two additional Zoom Frame TS keys: `m` max frame `f` fullscreen
2018-08-25 02:23:13 +00:00
| Key binding | Description |
|---------------------------------------+--------------------------------------------------------------------------------|
| ~SPC z x +~, ~SPC z x =~, ~SPC z x k~ | scale up the font and initiate the font scaling transient state |
Add transient state keys _, j, k Thanks sdwolfz for the suggestion to add underscore to the transient states, then the shift key doesn't have to be released if it was held down to press `+`. Added key bindings: Evil numbers: `SPC n _` decrease number under point in the transient state: `j` decrease number under point `k` increase number under point `SPC T T _` decrease transparency `SPC z x _` scale down font `SPC z f _` zoom out frame Update documentation: Zoom frame: `q` quit transient state Evil numbers: `SPC n =` increase number under point `SPC n _` decrease number under point `0..9` add a number prefix argument `q` quit transient state Fixed a typo and made a small rewrite of the tip about using a prefix argument. Added keys to transient states: Font scaling: Added `_` scale down Reordered `k` assignment to match the order in the transient state Frame transparency: Added `_` decrease Reordered `k` assignment to match the order in the transient state Evil numbers: Added `k` increase Added `_` and `j` decrease Zoom frame: Added `_` zoom frame out Reordered `k` assignment to match the order in the transient state Which-key entries for Evil numbers `SPC n`: Group together keys that call the same command: From: + and = To: +,= From: - and _ To: -,_
2019-05-20 17:10:51 +00:00
| ~SPC z x -~, ~SPC z x _~, ~SPC z x j~ | scale down the font and initiate the font scaling transient state |
Add j and k to transient states It is nicer when user can stay in the "home row" for basic operations like zooming in and out Font Scaling Transient State `k` scale up `j` scale down Frame Transparency Transient State `k` increase transparency `j` decrease transparency Zoom Frame Transient State `k` zoom frame in `j` zoom frame out Added two additional Zoom Frame TS keys: `m` max frame `f` fullscreen
2018-08-25 02:23:13 +00:00
| ~SPC z x 0~ | reset the font size (no scaling) and initiate the font scaling transient state |
Add 'z' recenter bindings for various transient states By analogy with the "zz", "zb", "zt" vim / evil bindings, this adds an additional key binding "z" for `recenter-top-bottom` to the following transient states which navigate around the buffer in large jumps: - auto-symbol-highlight - error - buffer - vcs - org-babel This allows for repositioning of the buffer for visibility without having to exit the transient state. Minor updates are also made to documentation of other transient states.
2018-10-22 08:09:55 +00:00
In the transient state:
Add j and k to transient states It is nicer when user can stay in the "home row" for basic operations like zooming in and out Font Scaling Transient State `k` scale up `j` scale down Frame Transparency Transient State `k` increase transparency `j` decrease transparency Zoom Frame Transient State `k` zoom frame in `j` zoom frame out Added two additional Zoom Frame TS keys: `m` max frame `f` fullscreen
2018-08-25 02:23:13 +00:00
| Key binding | Description |
|---------------+------------------------|
| ~+~, ~=~, ~k~ | increase the font size |
Add transient state keys _, j, k Thanks sdwolfz for the suggestion to add underscore to the transient states, then the shift key doesn't have to be released if it was held down to press `+`. Added key bindings: Evil numbers: `SPC n _` decrease number under point in the transient state: `j` decrease number under point `k` increase number under point `SPC T T _` decrease transparency `SPC z x _` scale down font `SPC z f _` zoom out frame Update documentation: Zoom frame: `q` quit transient state Evil numbers: `SPC n =` increase number under point `SPC n _` decrease number under point `0..9` add a number prefix argument `q` quit transient state Fixed a typo and made a small rewrite of the tip about using a prefix argument. Added keys to transient states: Font scaling: Added `_` scale down Reordered `k` assignment to match the order in the transient state Frame transparency: Added `_` decrease Reordered `k` assignment to match the order in the transient state Evil numbers: Added `k` increase Added `_` and `j` decrease Zoom frame: Added `_` zoom frame out Reordered `k` assignment to match the order in the transient state Which-key entries for Evil numbers `SPC n`: Group together keys that call the same command: From: + and = To: +,= From: - and _ To: -,_
2019-05-20 17:10:51 +00:00
| ~-~, ~_~, ~j~ | decrease the font size |
Add j and k to transient states It is nicer when user can stay in the "home row" for basic operations like zooming in and out Font Scaling Transient State `k` scale up `j` scale down Frame Transparency Transient State `k` increase transparency `j` decrease transparency Zoom Frame Transient State `k` zoom frame in `j` zoom frame out Added two additional Zoom Frame TS keys: `m` max frame `f` fullscreen
2018-08-25 02:23:13 +00:00
| ~0~ | reset the font size |
Add transient state keys _, j, k Thanks sdwolfz for the suggestion to add underscore to the transient states, then the shift key doesn't have to be released if it was held down to press `+`. Added key bindings: Evil numbers: `SPC n _` decrease number under point in the transient state: `j` decrease number under point `k` increase number under point `SPC T T _` decrease transparency `SPC z x _` scale down font `SPC z f _` zoom out frame Update documentation: Zoom frame: `q` quit transient state Evil numbers: `SPC n =` increase number under point `SPC n _` decrease number under point `0..9` add a number prefix argument `q` quit transient state Fixed a typo and made a small rewrite of the tip about using a prefix argument. Added keys to transient states: Font scaling: Added `_` scale down Reordered `k` assignment to match the order in the transient state Frame transparency: Added `_` decrease Reordered `k` assignment to match the order in the transient state Evil numbers: Added `k` increase Added `_` and `j` decrease Zoom frame: Added `_` zoom frame out Reordered `k` assignment to match the order in the transient state Which-key entries for Evil numbers `SPC n`: Group together keys that call the same command: From: + and = To: +,= From: - and _ To: -,_
2019-05-20 17:10:51 +00:00
| ~q~ | quit transient state |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Note that /only/ the text of the current buffer is scaled, the other buffers,
the mode-line and the minibuffer are not affected. To zoom the whole content of
a frame use the =zoom frame= bindings (see next section).
**** Frame
You can zoom in and out the whole content of the frame with the commands:
Add j and k to transient states It is nicer when user can stay in the "home row" for basic operations like zooming in and out Font Scaling Transient State `k` scale up `j` scale down Frame Transparency Transient State `k` increase transparency `j` decrease transparency Zoom Frame Transient State `k` zoom frame in `j` zoom frame out Added two additional Zoom Frame TS keys: `m` max frame `f` fullscreen
2018-08-25 02:23:13 +00:00
| Key binding | Description |
|---------------------------------------+-----------------------------------------------------------------------------|
| ~SPC z f +~, ~SPC z f =~, ~SPC z f k~ | zoom in the frame content and initiate the frame scaling transient state |
Add transient state keys _, j, k Thanks sdwolfz for the suggestion to add underscore to the transient states, then the shift key doesn't have to be released if it was held down to press `+`. Added key bindings: Evil numbers: `SPC n _` decrease number under point in the transient state: `j` decrease number under point `k` increase number under point `SPC T T _` decrease transparency `SPC z x _` scale down font `SPC z f _` zoom out frame Update documentation: Zoom frame: `q` quit transient state Evil numbers: `SPC n =` increase number under point `SPC n _` decrease number under point `0..9` add a number prefix argument `q` quit transient state Fixed a typo and made a small rewrite of the tip about using a prefix argument. Added keys to transient states: Font scaling: Added `_` scale down Reordered `k` assignment to match the order in the transient state Frame transparency: Added `_` decrease Reordered `k` assignment to match the order in the transient state Evil numbers: Added `k` increase Added `_` and `j` decrease Zoom frame: Added `_` zoom frame out Reordered `k` assignment to match the order in the transient state Which-key entries for Evil numbers `SPC n`: Group together keys that call the same command: From: + and = To: +,= From: - and _ To: -,_
2019-05-20 17:10:51 +00:00
| ~SPC z f -~, ~SPC z f _~, ~SPC z f j~ | zoom out the frame content and initiate the frame scaling transient state |
Add j and k to transient states It is nicer when user can stay in the "home row" for basic operations like zooming in and out Font Scaling Transient State `k` scale up `j` scale down Frame Transparency Transient State `k` increase transparency `j` decrease transparency Zoom Frame Transient State `k` zoom frame in `j` zoom frame out Added two additional Zoom Frame TS keys: `m` max frame `f` fullscreen
2018-08-25 02:23:13 +00:00
| ~SPC z f 0~ | reset the frame content size and initiate the frame scaling transient state |
In the transient state:
Add transient state keys _, j, k Thanks sdwolfz for the suggestion to add underscore to the transient states, then the shift key doesn't have to be released if it was held down to press `+`. Added key bindings: Evil numbers: `SPC n _` decrease number under point in the transient state: `j` decrease number under point `k` increase number under point `SPC T T _` decrease transparency `SPC z x _` scale down font `SPC z f _` zoom out frame Update documentation: Zoom frame: `q` quit transient state Evil numbers: `SPC n =` increase number under point `SPC n _` decrease number under point `0..9` add a number prefix argument `q` quit transient state Fixed a typo and made a small rewrite of the tip about using a prefix argument. Added keys to transient states: Font scaling: Added `_` scale down Reordered `k` assignment to match the order in the transient state Frame transparency: Added `_` decrease Reordered `k` assignment to match the order in the transient state Evil numbers: Added `k` increase Added `_` and `j` decrease Zoom frame: Added `_` zoom frame out Reordered `k` assignment to match the order in the transient state Which-key entries for Evil numbers `SPC n`: Group together keys that call the same command: From: + and = To: +,= From: - and _ To: -,_
2019-05-20 17:10:51 +00:00
| Key binding | Description |
|---------------+----------------------|
| ~+~, ~=~, ~k~ | zoom frame in |
| ~-~, ~_~, ~j~ | zoom frame out |
| ~0~ | reset frame zoom |
| ~q~ | quit transient state |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
*** Increase/Decrease numbers
Fix typo in doc/DOCUMENTATION.org increase or increase --> increase or decrease parenthesis --> parentheses
2016-07-31 19:24:31 +00:00
Spacemacs uses [[https://github.com/cofi/evil-numbers][evil-numbers]] to easily increase or decrease numbers.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Add transient state keys _, j, k Thanks sdwolfz for the suggestion to add underscore to the transient states, then the shift key doesn't have to be released if it was held down to press `+`. Added key bindings: Evil numbers: `SPC n _` decrease number under point in the transient state: `j` decrease number under point `k` increase number under point `SPC T T _` decrease transparency `SPC z x _` scale down font `SPC z f _` zoom out frame Update documentation: Zoom frame: `q` quit transient state Evil numbers: `SPC n =` increase number under point `SPC n _` decrease number under point `0..9` add a number prefix argument `q` quit transient state Fixed a typo and made a small rewrite of the tip about using a prefix argument. Added keys to transient states: Font scaling: Added `_` scale down Reordered `k` assignment to match the order in the transient state Frame transparency: Added `_` decrease Reordered `k` assignment to match the order in the transient state Evil numbers: Added `k` increase Added `_` and `j` decrease Zoom frame: Added `_` zoom frame out Reordered `k` assignment to match the order in the transient state Which-key entries for Evil numbers `SPC n`: Group together keys that call the same command: From: + and = To: +,= From: - and _ To: -,_
2019-05-20 17:10:51 +00:00
| Key binding | Description |
|----------------------+---------------------------------------------------------------------|
| ~SPC n +~, ~SPC n =~ | increase the number under point by one and initiate transient state |
| ~SPC n -~, ~SPC n _~ | decrease the number under point by one and initiate transient state |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Add 'z' recenter bindings for various transient states By analogy with the "zz", "zb", "zt" vim / evil bindings, this adds an additional key binding "z" for `recenter-top-bottom` to the following transient states which navigate around the buffer in large jumps: - auto-symbol-highlight - error - buffer - vcs - org-babel This allows for repositioning of the buffer for visibility without having to exit the transient state. Minor updates are also made to documentation of other transient states.
2018-10-22 08:09:55 +00:00
In the transient state:
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Add transient state keys _, j, k Thanks sdwolfz for the suggestion to add underscore to the transient states, then the shift key doesn't have to be released if it was held down to press `+`. Added key bindings: Evil numbers: `SPC n _` decrease number under point in the transient state: `j` decrease number under point `k` increase number under point `SPC T T _` decrease transparency `SPC z x _` scale down font `SPC z f _` zoom out frame Update documentation: Zoom frame: `q` quit transient state Evil numbers: `SPC n =` increase number under point `SPC n _` decrease number under point `0..9` add a number prefix argument `q` quit transient state Fixed a typo and made a small rewrite of the tip about using a prefix argument. Added keys to transient states: Font scaling: Added `_` scale down Reordered `k` assignment to match the order in the transient state Frame transparency: Added `_` decrease Reordered `k` assignment to match the order in the transient state Evil numbers: Added `k` increase Added `_` and `j` decrease Zoom frame: Added `_` zoom frame out Reordered `k` assignment to match the order in the transient state Which-key entries for Evil numbers `SPC n`: Group together keys that call the same command: From: + and = To: +,= From: - and _ To: -,_
2019-05-20 17:10:51 +00:00
| Key binding | Description |
|---------------+----------------------------------------|
| ~+~, ~=~, ~k~ | increase the number under point by one |
| ~-~, ~_~, ~j~ | decrease the number under point by one |
| ~0..9~ | add a number prefix argument |
| ~q~ | quit transient state |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Add transient state keys _, j, k Thanks sdwolfz for the suggestion to add underscore to the transient states, then the shift key doesn't have to be released if it was held down to press `+`. Added key bindings: Evil numbers: `SPC n _` decrease number under point in the transient state: `j` decrease number under point `k` increase number under point `SPC T T _` decrease transparency `SPC z x _` scale down font `SPC z f _` zoom out frame Update documentation: Zoom frame: `q` quit transient state Evil numbers: `SPC n =` increase number under point `SPC n _` decrease number under point `0..9` add a number prefix argument `q` quit transient state Fixed a typo and made a small rewrite of the tip about using a prefix argument. Added keys to transient states: Font scaling: Added `_` scale down Reordered `k` assignment to match the order in the transient state Frame transparency: Added `_` decrease Reordered `k` assignment to match the order in the transient state Evil numbers: Added `k` increase Added `_` and `j` decrease Zoom frame: Added `_` zoom frame out Reordered `k` assignment to match the order in the transient state Which-key entries for Evil numbers `SPC n`: Group together keys that call the same command: From: + and = To: +,= From: - and _ To: -,_
2019-05-20 17:10:51 +00:00
*Tips:* You can increase or decrease a number by more than one at a time, by
using a prefix argument (i.e. ~10 SPC n +~ will add =10= to the number under
point).
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
*** Spell checking
Convert new exporter into standalone tool
2017-07-29 07:41:05 +00:00
Spell checking is enabled by including the [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Bcheckers/spell-checking/README.org][spell
Make it clear in global docs that spell checking is a layer
2015-10-08 07:20:42 +00:00
checking]] layer in your dotfile.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
documentation fixes: Tue Oct 23 14:18:21 UTC 2018
2018-10-23 14:18:21 +00:00
Key bindings are listed in the layer documentation.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
*** Region selection
Vi =Visual= modes are all supported by =evil=.
**** Expand-region
Doc: replace all occurences of =Spacemacs= by Spacemacs
2015-09-27 14:18:57 +00:00
Spacemacs adds another =Visual= mode via the [[https://github.com/magnars/expand-region.el][expand-region]] mode.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
|-------------+------------------------------------------|
| ~SPC v~ | initiate expand-region mode then... |
| ~v~ | expand the region by one semantic unit |
| ~V~ | contract the region by one semantic unit |
| ~r~ | reset the region to initial selection |
| ~ESC~ | leave expand-region mode |
**** Indent text object
Update indent textobjects documentation
2016-06-22 16:37:28 +00:00
With [[https://github.com/TheBB/evil-indent-plus][evil-indent-plus]] the following text objects are available:
- ~ii~ - Inner Indentation: the surrounding textblock with the same indentation
- ~iI~ - Above and Indentation: ~ii~ + the line above with a different indentation
DOCUMENTATION.org: fix indent text object docs
2016-06-23 12:20:16 +00:00
- ~iJ~ - Above, Below and Indentation+: ~iI~ + the line below with a different indentation
Reformat documentation
2018-09-19 03:54:47 +00:00
- There are also ~a~ variants that include whitespace. Example (=|= indicates point):
Update indent textobjects documentation
2016-06-22 16:37:28 +00:00
Reformat documentation
2018-09-19 03:54:47 +00:00
#+BEGIN_SRC emacs-lisp
(while (not done)
(messa|ge "All work and no play makes Jack a dull boy."))
(1+ 41)
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Reformat documentation
2018-09-19 03:54:47 +00:00
- ~vii~ will select the line with message
- ~viI~ will select the whole while loop
- ~viJ~ will select the whole fragment
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
*** Region narrowing
The displayed text of a buffer can be narrowed with the commands (start with
~n~):
[core] document new narrow to indirect buffer keybindings
2020-10-26 12:57:25 +00:00
| Key binding | Description |
|-------------+------------------------------------------------------|
| ~SPC n f~ | narrow the buffer to the current function |
| ~SPC n p~ | narrow the buffer to the visible page |
| ~SPC n r~ | narrow the buffer to the selected text |
| ~SPC n w~ | widen, i.e. show the whole buffer again |
| ~SPC n F~ | narrow to the current function in an indirect buffer |
| ~SPC n P~ | narrow to the visible page in an indirect buffer |
| ~SPC n R~ | narrow to the selected text in an indirect buffer |
Narrowing in an indirect buffer overcomes the problem that a buffer can only be
narrowed in one place at a given time.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
*** Replacing text with iedit
Doc: replace all occurences of =Spacemacs= by Spacemacs
2015-09-27 14:18:57 +00:00
Spacemacs uses the powerful [[https://github.com/tsdh/iedit][iedit]] mode through [[https://github.com/syl20bnr/evil-iedit-state][evil-iedit-state]] to quickly
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
edit multiple occurrences of a symbol or selection.
=evil-iedit-state= defines two new evil states:
Reformat documentation
2018-09-19 03:54:47 +00:00
- =iedit state=
- =iedit-insert state=
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
The color code for these states is =red=.
=evil-iedit-state= has also a nice integration with [[https://github.com/magnars/expand-region.el][expand-region]] for quick
Correct the documentation
2015-10-24 19:27:29 +00:00
editing of the currently selected text by pressing ~e~.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
**** iedit states key bindings
***** State transitions
Format documenation files with doc-fmt tool
2016-04-13 03:31:38 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | From | To |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
|-------------+------------------+--------|
| ~SPC s e~ | normal or visual | iedit |
| ~e~ | expand-region | iedit |
| ~ESC~ | iedit | normal |
| ~C-g~ | iedit | normal |
| ~fd~ | iedit | normal |
| ~ESC~ | iedit-insert | iedit |
| ~C-g~ | iedit-insert | normal |
| ~fd~ | iedit-insert | normal |
To sum-up, in =iedit-insert state= you have to press ESC twice to go back to the
=normal state=. You can also at any time press ~C-g~ or ~fd~ to return to =normal
state=.
Consitently format Note: lines in DOCUMENTATION.org. Format is: *Note*: note here
2015-09-05 07:57:50 +00:00
*Note*: evil commands which switch to =insert state= will switch in
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
=iedit-insert state=.
***** In iedit state
=iedit state= inherits from =normal state=, the following key bindings are
specific to =iedit state=.
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
|-------------+-----------------------------------------------------------------------------------------|
| ~ESC~ | go back to =normal state= |
| ~TAB~ | toggle current occurrence |
| ~0~ | go to the beginning of the current occurrence |
| ~$~ | go to the end of the current occurrence |
| ~#~ | prefix all occurrences with an increasing number (SPC u to choose the starting number). |
| ~A~ | go to the end of the current occurrence and switch to =iedit-insert state= |
| ~D~ | delete the occurrences |
| ~F~ | restrict the scope to the function |
| ~gg~ | go to first occurrence |
| ~G~ | go to last occurrence |
| ~I~ | go to the beginning of the current occurrence and switch to =iedit-insert state= |
Correct the documentation
2015-10-24 19:27:29 +00:00
| ~J~ | increase the editing scope by one line below |
| ~K~ | increase the editing scope by one line above |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
| ~L~ | restrict the scope to the current line |
| ~n~ | go to next occurrence |
| ~N~ | go to previous occurrence |
| ~p~ | replace occurrences with last yanked (copied) text |
| ~S~ | (substitute) delete the occurrences and switch to =iedit-insert state= |
| ~V~ | toggle visibility of lines with no occurrence |
| ~U~ | Up-case the occurrences |
| ~C-U~ | down-case the occurrences |
Consitently format Note: lines in DOCUMENTATION.org. Format is: *Note*: note here
2015-09-05 07:57:50 +00:00
*Note*: ~0~, ~$~, ~A~ and ~I~ have the default Vim behavior when used outside of
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
an ~occurrence~.
***** In iedit-insert state
Format documenation files with doc-fmt tool
2016-04-13 03:31:38 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
|-------------+---------------------------|
| ~ESC~ | go back to =iedit state= |
| ~C-g~ | go back to =normal state= |
**** Examples
Reformat documentation
2018-09-19 03:54:47 +00:00
- manual selection of several words then replace: ~v w w SPC s e S "toto" ESC ESC~
- append text to a word on two lines: ~v i w SPC s e J i "toto" ESC ESC~
- substitute symbol /with expand-region/: ~SPC v v e S "toto" ESC ESC~
- replace symbol with yanked (copied) text /with expand region/:
~SPC v e p ESC ESC~
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
*** Replacing text in several files
Add ripgrep support * Add rg to helm completion layer * Add rg to ivy layer * Prepend rg to dotspacemacs-search-tools * Add rg to documentation
2016-10-20 00:29:06 +00:00
If you have =rg=, =ag=, =pt= or =ack= installed, replacing an occurrence of text
in several files can be performed via [[https://github.com/syohex/emacs-helm-ag][helm-ag]].
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Say you want to replace all =foo= occurrences by =bar= in your current
project:
Reformat documentation
2018-09-19 03:54:47 +00:00
- initiate a search with ~SPC /~
- enter in edit mode with ~C-c C-e~
- go to the occurrence and enter in =iedit state= with ~SPC s e~
- edit the occurrences then leave the =iedit state=
- press ~C-c C-c~
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Add ripgrep support * Add rg to helm completion layer * Add rg to ivy layer * Prepend rg to dotspacemacs-search-tools * Add rg to documentation
2016-10-20 00:29:06 +00:00
*Note*: In Spacemacs, =helm-ag= despite its name works with =rg=, =pt= and =ack=
as well (but not with =grep=).
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Add documentation for C-c C-e in helm-find-files
2016-03-11 01:31:42 +00:00
*** Renaming files in a directory
It is possible to batch rename files in a directory using =wdired= from an
=helm= session:
- browse for a directory using ~SPC f f~
- enter =wdired= with ~C-c C-e~
- edit the file names and use ~C-c C-c~ to confirm the changes
- use ~C-c C-k~ to abort any changes
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
*** Commenting
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
Comments are handled by [[https://github.com/redguardtoo/evil-nerd-commenter][evil-nerd-commenter]], it's bound to the following keys.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
|-------------+---------------------------|
| ~SPC ;~ | comment operator |
Add hide/show comments on SPC c h
2016-10-17 19:25:21 +00:00
| ~SPC c h~ | hide/show comments |
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
| ~SPC c l~ | comment lines |
| ~SPC c L~ | invert comment lines |
| ~SPC c p~ | comment paragraphs |
| ~SPC c P~ | invert comment paragraphs |
| ~SPC c t~ | comment to line |
| ~SPC c T~ | invert comment to line |
| ~SPC c y~ | comment and yank |
| ~SPC c Y~ | invert comment and yank |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Documentation has outdated shortcut The suggestions to use SPC ; SPC y is from the previous versions where SPC y was bound to avy-goto-line. Now that command is bound to SPC j l
2016-11-16 07:39:07 +00:00
*Tips:* To comment efficiently a block of line use the combo ~SPC ; SPC j l~
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Move pcre2el key bindings to SPC x r prefix Also document it. Move everything to spacemacs-base since the new prefix is not as invasive
2016-06-13 03:57:34 +00:00
*** Regular expressions
Spacemacs uses the packages [[https://github.com/joddie/pcre2el][pcre2el]] to manipulate regular expressions. It is
useful when working with =Emacs Lisp= buffers since it allows to easily converts
=PCRE= (Perl Compatible RegExp) to Emacs RegExp or =rx=. It can also be used to
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
"explain" a PCRE RegExp around point in =rx= form.
Move pcre2el key bindings to SPC x r prefix Also document it. Move everything to spacemacs-base since the new prefix is not as invasive
2016-06-13 03:57:34 +00:00
The key bindings start with ~SPC x r~ and have the following mnemonic structure:
- ~SPC x r <source> <target>~ convert from source to target
- ~SPC x r~ do what I mean
documentation formatting: Mon Feb 24 00:14:51 UTC 2020
2020-02-24 00:14:51 +00:00
| Key binding | Description |
Move pcre2el key bindings to SPC x r prefix Also document it. Move everything to spacemacs-base since the new prefix is not as invasive
2016-06-13 03:57:34 +00:00
|---------------+----------------------------------------------------------------------------------------|
| ~SPC x r /~ | Explain the regexp around point with =rx= |
| ~SPC x r '​~ | Generate strings given by a regexp given this list is finite |
| ~SPC x r t~ | Replace regexp around point by the =rx= form or vice versa |
documentation fixes: Tue Oct 23 14:18:21 UTC 2018
2018-10-23 14:18:21 +00:00
| ~SPC x r x~ | Convert regexp around point in =rx= form and display the result in the minibuffer |
Move pcre2el key bindings to SPC x r prefix Also document it. Move everything to spacemacs-base since the new prefix is not as invasive
2016-06-13 03:57:34 +00:00
| ~SPC x r c~ | Convert regexp around point to the other form and display the result in the minibuffer |
| ~SPC x r e /~ | Explain Emacs Lisp regexp |
| ~SPC x r e '​~ | Generate strings from Emacs Lisp regexp |
| ~SPC x r e p~ | Convert Emacs Lisp regexp to PCRE |
| ~SPC x r e t~ | Replace Emacs Lisp regexp by =rx= form or vice versa |
| ~SPC x r e x~ | Convert Emacs Lisp regexp to =rx= form |
| ~SPC x r p /~ | Explain PCRE regexp |
| ~SPC x r p '​~ | Generate strings from PCRE regexp |
| ~SPC x r p e~ | Convert PCRE regexp to Emacs Lisp |
| ~SPC x r p x~ | Convert PCRE to =rx= form |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
*** Deleting files
Deletion is configured to send deleted files to system trash.
Update references to macOS Apple renamed "Mac OS X" to "OS X" in 2012 and then to "macOS" in 2016. Update references to use the current name.
2019-10-13 05:27:17 +00:00
On macOS the =trash= program is required. It can be installed with [[https://brew.sh/][homebrew]] with
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
the following command:
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+BEGIN_SRC sh
Reformat documentation
2018-09-19 03:54:47 +00:00
$ brew install trash
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
To disable the trash you can set the variable =delete-by-moving-to-trash= to
=nil= in your =~/.spacemacs=.
*** Editing Lisp code
Correct the documentation
2015-10-24 19:27:29 +00:00
Editing of lisp code is provided by [[https://github.com/syl20bnr/evil-lisp-state][evil-lisp-state]].
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Commands will set the current state to =lisp state= where different commands
Fixed a typo in Editing Lisp code section.
2015-10-31 10:53:19 +00:00
combo can be repeated without pressing on ~SPC k~.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
When in =lisp state= the color of the mode-line changes to pink.
Examples:
Reformat documentation
2018-09-19 03:54:47 +00:00
- to slurp three times while in normal state: ~SPC k 3 s~
- to wrap a symbol in parentheses then slurp two times: ~SPC k w 2 s~
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Consitently format Note: lines in DOCUMENTATION.org. Format is: *Note*: note here
2015-09-05 07:57:50 +00:00
*Note*: The =lisp state= commands are available in /any/ modes! Try it out.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
**** Lisp Key bindings
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
***** Lisp state key bindings
These commands automatically switch to =lisp state=.
[doc] Flatten headlines that are too deep
2021-07-05 20:40:24 +00:00
Navigation:
Group lisp state key bindings (#14790)
2021-05-27 06:01:26 +00:00
| Key binding | Description |
|-------------+-------------------------------------------------------------------------|
| | Forward + Backward pairs |
|-------------+-------------------------------------------------------------------------|
| ~SPC k j~ | go forward to next closing parenthesis |
| ~SPC k k~ | go backward to previous opening parenthesis |
| ~SPC k l~ | go forward to next symbol |
| ~SPC k h~ | go backward to previous symbol |
| ~SPC k L~ | go forward to next sexp |
| ~SPC k H~ | go backward to previous sexp |
| ~SPC k $~ | go forward to the end of current sexp |
| ~SPC k 0~ | go backward to the beginning of current sexp |
|-------------+-------------------------------------------------------------------------|
| | Other |
|-------------+-------------------------------------------------------------------------|
| ~SPC k U~ | go "up": to parent sexp backward |
| ~SPC k %~ | go to other paren of the same pair |
| ~SPC k I~ | go back to beginning of current expression and switch to =insert= state |
[doc] Flatten headlines that are too deep
2021-07-05 20:40:24 +00:00
Manipulation:
Group lisp state key bindings (#14790)
2021-05-27 06:01:26 +00:00
| Key binding | Description |
|-------------+--------------------------------------------------------------|
| ~SPC k s~ | slurp forward: ~a (bs) c~ -> ~a (bs c)~ |
| ~SPC k S~ | slurp backward: ~a (bs) c~ -> ~(a bs) c~ |
| ~SPC k b~ | barf forward: ~(a bs c)~ -> ~(a bs) c~ |
| ~SPC k B~ | barf backward: ~(a bs c)~ -> ~a (bs c)~ |
| ~SPC k a~ | absorb: ~(a (bs <point> ..))~ -> ~((bs a <point> ..))~ |
| ~SPC k c~ | convolute: ~(as (bs <point> ..))~ -> ~(bs (as <point> ..))~ |
| ~SPC k t~ | transpose: ~(as <point> bs)~ -> ~(bs <point> as)~ |
| ~SPC k J~ | join: ~(as) <point> (bs)~ -> ~(as <point> bs)~ |
|-------------+--------------------------------------------------------------|
| | Hybrid (= better for non-Lisp languages) commands |
|-------------+--------------------------------------------------------------|
| ~SPC k ` s~ | hybrid slurp forward |
| ~SPC k ` p~ | hybrid push: ~<point>as bs~ -> ~<point>bs as~ |
| ~SPC k ` t~ | hybrid transpose: ~as <point> bs~ -> ~bs <point> as~ |
|-------------+--------------------------------------------------------------|
| Note 1: | ~xs~ is one or multiple sexp, ~x~ is a single sexp |
| Note 2: | point is at <point> when presented, or in the list otherwise |
[doc] Flatten headlines that are too deep
2021-07-05 20:40:24 +00:00
Insertion:
Group lisp state key bindings (#14790)
2021-05-27 06:01:26 +00:00
| Key binding | Description |
|-------------+--------------------------------|
| ~SPC k (~ | insert sexp before current one |
| ~SPC k )~ | insert sexp after current one |
| ~SPC k w~ | wrap a symbol with parenthesis |
[doc] Flatten headlines that are too deep
2021-07-05 20:40:24 +00:00
Deletion:
Group lisp state key bindings (#14790)
2021-05-27 06:01:26 +00:00
[base] Refactor keyboard macro key bindings
2020-02-23 14:40:01 +00:00
| Key binding | Description |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
|-------------+---------------------------------------------------------------------|
| ~SPC k ds~ | delete symbol |
Group lisp state key bindings (#14790)
2021-05-27 06:01:26 +00:00
| ~SPC k Ds~ | delete symbol backward |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
| ~SPC k dw~ | delete word |
Group lisp state key bindings (#14790)
2021-05-27 06:01:26 +00:00
| ~SPC k Dw~ | delete word backward |
| ~SPC k dx~ | delete sexp: ~(as <point> a ..)~ -> ~(as <point> ..)~ |
| ~SPC k Dx~ | delete sexp backward: ~(as a <point> ..)~ -> ~(as <point> ..)~ |
| ~SPC k e~ | splice, killing forward: ~(as (bs <point> cs) ds)~ -> ~(as bs ds)~ |
| ~SPC k E~ | splice, killing backward: ~(as (bs <point> cs) ds)~ -> ~(as cs ds)~ |
| ~SPC k r~ | raise: ~(as <point> b ..)~ -> ~<point>b~ |
| ~SPC k W~ | unwrap sexp: ~(as)~ -> ~as~ |
|-------------+---------------------------------------------------------------------|
| | Hybrid (= better for non-Lisp languages) commands |
|-------------+---------------------------------------------------------------------|
| ~SPC k ` k~ | hybrid delete sexp |
|-------------+---------------------------------------------------------------------|
| Note 1: | ~xs~ is one or multiple sexp, ~x~ is a single sexp |
| Note 2: | point is at ~<point>~ when presented, or in the list otherwise |
[doc] Flatten headlines that are too deep
2021-07-05 20:40:24 +00:00
Bindings from normal state:
Group lisp state key bindings (#14790)
2021-05-27 06:01:26 +00:00
For convenience, a number of normal state evil binding are available in lisp state as well:
| Key binding | Description |
|-------------+-------------------------------------------------------------|
| ~SPC k :~ | ex command |
| ~SPC k i~ | switch to =insert= state |
| ~SPC k I~ | switch to =insert= state at beginning of current line |
| ~SPC k v~ | switch to =visual= state and begin character-wise selection |
| ~SPC k V~ | switch to =visual= state and begin line-wise selection |
| ~SPC k C-v~ | switch to =visual= state and begin block-wise selection |
| ~SPC k u~ | undo |
| ~SPC k C-r~ | redo |
| ~SPC k y~ | copy expression |
| ~SPC k p~ | paste after |
| ~SPC k P~ | paste before |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
***** Emacs lisp specific key bindings
Format documenation files with doc-fmt tool
2016-04-13 03:31:38 +00:00
[base] Refactor keyboard macro key bindings
2020-02-23 14:40:01 +00:00
| Key binding | Description |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
|-------------+----------------------------------------------------|
[base] Refactor keyboard macro key bindings
2020-02-23 14:40:01 +00:00
| ~SPC m e $~ | go to end of line and evaluate last sexp |
| ~SPC m e b~ | evaluate buffer |
| ~SPC m e c~ | evaluate current form (a =def= or a =set=) |
| ~SPC m e e~ | evaluate last sexp |
| ~SPC m e f~ | evaluate current defun |
| ~SPC m e l~ | go to end of line and evaluate last sexp |
| ~SPC m e r~ | evaluate region |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
| ~SPC m g g~ | go to definition |
Remove SPC j F and SPC j V and add SPC m g G in Emacs Lisp SPC j F and SPC j V don't fit the SPC j prefix because they require the thing under point to be an Emacs lisp thing, which means that these bindings should be major mode specific. To replace them and accordingly to the convention the key bindings SPC m g G in Emacs Lisp buffers has been added to go to definition in other window. SPC j f and SPC j v (minus letters) don't require the current buffer to be Emacs Lisp and thus I only updated the documentation about them mentioning that they're about Emacs Lisp variables and functions.
2016-08-26 01:19:21 +00:00
| ~SPC m g G~ | go to definition in another window |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
| ~SPC m h h~ | describe elisp thing at point (show documentation) |
| ~SPC m t b~ | execute buffer tests |
| ~SPC m t q~ | ask for test function to execute |
[base] Refactor keyboard macro key bindings
2020-02-23 14:40:01 +00:00
*** Keyboard macros
Keyboard macros are a powerful feature of Emacs. A keyboard macro is a record of
keystrokes that can be replayed at any time.
[doc] Update keyboard macro documentation The key bindings were wrapped in a comment block, which prevented them from appearing. Added recording steps with explanations.
2020-02-23 20:19:50 +00:00
*Important note:* When creating a macro, do not use the =evil-escape= key
sequence (by default press ~fd~ quickly), instead press the ~ESC~ key
explicitly. Currently =evil-escape= does not support being replayed in macros.
[base] Refactor keyboard macro key bindings
2020-02-23 14:40:01 +00:00
**** Vim keyboard macros
[doc] Update keyboard macro documentation The key bindings were wrapped in a comment block, which prevented them from appearing. Added recording steps with explanations.
2020-02-23 20:19:50 +00:00
Spacemacs supports the VIM interface for creating macros in normal state using
~q~ to start a macro and ~@~ to play a macro.
To record a keyboard macro:
- Press ~q~ (there's no visual indicator, but it's waiting for a letter key to
be pressed).
- Press a letter key to start recording to that letter register.
(the minibuffer shows: Defining kbd macro...)
- Perform the actions that will be recorded.
- Press ~q~ to stop recording the macro.
(the minibuffer shows: Keyboard macro defined).
To execute a recorded macro:
(A macro can be played back multiple times, by typing a number before starting
the macro)
- Press ~@~ (the minibuffer shows: ~@-~, and it waits for a letter register key
to be pressed).
- Press a letter key for a register where a previous macro has been recorded.
- The macro can be repeated by pressing the repeat last editing command key:
~.~ (period).
[base] Refactor keyboard macro key bindings
2020-02-23 14:40:01 +00:00
**** Emacs keyboard macros
[doc] Update keyboard macro documentation The key bindings were wrapped in a comment block, which prevented them from appearing. Added recording steps with explanations.
2020-02-23 20:19:50 +00:00
The Emacs way to define macros is available behind the prefix: ~SPC K~
[base] Refactor keyboard macro key bindings
2020-02-23 14:40:01 +00:00
[doc] Update keyboard macro documentation The key bindings were wrapped in a comment block, which prevented them from appearing. Added recording steps with explanations.
2020-02-23 20:19:50 +00:00
To start recording a keyboard macro:
- Press ~SPC K k~ (uppercase then lowercase) to start recording a macro.
- Perform the actions that should be recorded.
- Press ~SPC K K~ (uppercase twice) to stop recording the macro.
[base] Refactor keyboard macro key bindings
2020-02-23 14:40:01 +00:00
[doc] Update keyboard macro documentation The key bindings were wrapped in a comment block, which prevented them from appearing. Added recording steps with explanations.
2020-02-23 20:19:50 +00:00
To execute the last recorded macro press: ~SPC K K~
The macro can be executed again by pressing ~K~ one or more times.
The single character replay works until another key than ~K~ is pressed.
[base] Refactor keyboard macro key bindings
2020-02-23 14:40:01 +00:00
***** Macro counter
[doc] Update keyboard macro documentation The key bindings were wrapped in a comment block, which prevented them from appearing. Added recording steps with explanations.
2020-02-23 20:19:50 +00:00
Emacs has an interesting concept: The macro counter.
When starting to record a macro, the counter starts at 0 (you can also set it to
a specific value), then each time the counter is inserted, it is incremented
by 1 afterwards.
[base] Refactor keyboard macro key bindings
2020-02-23 14:40:01 +00:00
[doc] Update keyboard macro documentation The key bindings were wrapped in a comment block, which prevented them from appearing. Added recording steps with explanations.
2020-02-23 20:19:50 +00:00
When recording a macro it's possible to insert the current value by pressing:
~SPC K k~
[base] Refactor keyboard macro key bindings
2020-02-23 14:40:01 +00:00
***** Key bindings
documentation formatting: Mon Feb 24 00:14:51 UTC 2020
2020-02-24 00:14:51 +00:00
[base] Refactor keyboard macro key bindings
2020-02-23 14:40:01 +00:00
| Key binding | Description |
|-------------+---------------------------------------------------------------------------|
| ~SPC K c a~ | increment macro counter |
| ~SPC K c c~ | insert the current value of the macro counter |
| ~SPC K c C~ | set the macro counter |
| ~SPC K c f~ | set the display format for the macro counter |
| ~SPC K e b~ | assign a key binding to the last macro |
| ~SPC K e e~ | edit last macro in a buffer |
| ~SPC K e l~ | edit a macro from lossage information (last 300 executed commands) |
| ~SPC K e n~ | give a name to the last macro |
| ~SPC K e r~ | write the last macro to a register (use ~SPC r r~ to call it) |
| ~SPC K e s~ | step by step edit of the last macro |
| ~SPC K k~ | start recording macro, if already recording then insert the macro counter |
| ~SPC K K~ | stop recording macro, if no macro is recording then run last macro |
| ~SPC K r L~ | view head macro in ring |
| ~SPC K r d~ | delete head macro in ring |
| ~SPC K r l~ | run second macro in ring |
| ~SPC K r n~ | cycle to next macro in ring |
| ~SPC K r p~ | cycle to previous macro in ring |
| ~SPC K r s~ | swap the first two macros in ring |
| ~SPC K v~ | view last macro string in minibuffer |
Add persistent-scratch and unkillable-scratch into core/spacemacs-editing layer (#14115)
2020-11-14 09:02:51 +00:00
*** Scratch buffer
Some features which could improve editing experience in =*scratch*= buffer.
**** Persistent scratch
Make your =*scratch*= buffer persistent. Everything you write down in =*scratch*= buffer will be automatically saved and restored.
You can set variable =dotspacemacs-scratch-buffer-persistent= with a non-nil value in your =.spacemacs= file to enable this feature.
**** Unkillable scratch
Make your =*scratch*= buffer not killable (bury instead).
You can set variable =dotspacemacs-scratch-buffer-unkillable= with a non-nil value in your =.spacemacs= file to enable this feature.
Move eyebrowse to spacemacs-layouts layer and add documentation Add toggle capability with ? for workspaces transient state Remove the variable eyebrowse-display-help
2016-03-21 01:48:06 +00:00
*** Mouse usage
There are some added mouse features set for the line number margin (if shown):
- single click in line number margin visually selects the entire line
- drag across line number margin visually selects the region
- double click in line number margin visually select the current code block
[default] Move ediff key bindings from SPC E to SPC D prefix And add documentation
2020-02-01 21:26:08 +00:00
** Comparing (diff)
To compare buffers, files, directories or even windows use the prefix ~SPC D~.
Spacemacs uses the powerful embedded =ediff= to do comparisons, help for =ediff=
can be opened using ~SPC D h~.
All =ediff= commands starts with D:
| Key binding | Description |
|---------------+-----------------------------------------------------------------------------------------------------------------------------------|
| ~SPC D b 3~ | ask for 3 opened buffers and start an ediff session with them |
| ~SPC D b b~ | ask for 2 opened buffers and start an ediff session with them |
| ~SPC D b p~ | ask for a buffer or file that contains a patch to apply to a buffer and start an ediff session with the result |
| ~SPC D B~ | ask for a file and run ediff with its backup file |
| ~SPC D d 3~ | ask for 3 directories and run ediff on them comparing files that have the same name in all of them |
| ~SPC D d d~ | ask for 2 directories and run ediff on them comparing files that have the same name in both |
| ~SPC D d r~ | run ediff on a directory comparing its files with their revisions if under version control |
| ~SPC D f .~ | start an ediff session between your =.spacemacs= and its default template in Spacemacs =core= |
| ~SPC D f 3~ | ask for 3 files and start an ediff session with them |
| ~SPC D f f~ | ask for 2 files and start an ediff session with them |
| ~SPC D f p~ | ask for a buffer or file that contains a patch to apply to a file and start an ediff session with the result |
Use spacebind for Differences key bindings
2020-03-01 14:48:22 +00:00
| ~SPC D f v~ | start ediff between versions of a file |
[default] Move ediff key bindings from SPC E to SPC D prefix And add documentation
2020-02-01 21:26:08 +00:00
| ~SPC D h~ | open ediff documentation within Emacs |
| ~SPC D m b 3~ | start an ediff merge session between 2 buffers and their ancestor |
| ~SPC D m b b~ | start an ediff merge session between 2 buffers |
| ~SPC D m d 3~ | start an ediff merge session between files with the same name in 2 directories and with a 3rd directory containing their ancestor |
| ~SPC D m d d~ | start an ediff merge session between files with the same name in 2 directories |
| ~SPC D m f 3~ | start an ediff merge session between 2 files and their ancestor |
| ~SPC D m f f~ | start an ediff merge session between 2 files |
| ~SPC D m r 3~ | start an ediff merge session between two revisions of a file with a common ancestor |
| ~SPC D m r r~ | start an ediff merge session between two revisions of a file |
| ~SPC D r l~ | start an ediff session between two regions to perform a linewise diff (use this for large regions) |
| ~SPC D r w~ | start an ediff session between two regions to perform a wordwise diff (use this for small regions) |
| ~SPC D s~ | display ediff registries |
| ~SPC D w l~ | compare linewise the portions of visible text of 2 windows which are selected by clicking |
| ~SPC D w w~ | compare wordwise the portions of visible text of 2 windows which are selected by clicking |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
** Managing projects
Doc: replace all occurences of =Spacemacs= by Spacemacs
2015-09-27 14:18:57 +00:00
Projects in Spacemacs are managed with [[https://github.com/bbatsov/projectile][projectile]]. In =projectile= projects
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
are defined implicitly, for instance the root of a project is found when a
=.git= repository or =.projectile= file is encountered in the file tree.
Fix export-breaking org links in documentation As discussed in #8054 and #8136, org doesn't always export links correctly if the syntax deviates from the one given on the org mode website. This results in broken links on github and/or spacemacs.org as in #6722, #8036, #8054, #7956 and possibly others. This modifies all links not already fixed in #8136. Internal links are handled with Custom IDs. External file links are formatted according to org guidelines as well (see bottom), and if they point to a specific headline in an external file, a custom ID is created as well. Fixes #6722, #8036, #7956, #7916 as well as other unreported broken links. http://orgmode.org/manual/External-links.html#External-links http://orgmode.org/manual/Internal-links.html#Internal-links TODO: make Custom IDs invisble in space-org-mode
2017-01-09 12:11:54 +00:00
To search in a project see [[#searching-in-a-project][project searching]].
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
=projectile= commands start with p:
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Multiple ways to copy a file path
2018-06-02 15:14:42 +00:00
|-------------+------------------------------------------------------------------------------------------|
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
| ~SPC p '​~ | open a shell in project's root (with the =shell= layer) |
| ~SPC p !~ | run shell command in project's root |
| ~SPC p &~ | run async shell command in project's root |
Multiple ways to copy a file path
2018-06-02 15:14:42 +00:00
| ~SPC p %~ | replace a regexp |
| ~SPC p a~ | toggle between implementation and test |
| ~SPC p b~ | switch to project buffer |
| ~SPC p c~ | compile project using =projectile= |
| ~SPC p d~ | find directory |
| ~SPC p D~ | open project root in =dired= |
| ~SPC p e~ | edit dir-locals.el |
| ~SPC p f~ | find file |
| ~SPC p F~ | find file based on path around point |
| ~SPC p g~ | find tags |
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
| ~SPC p G~ | regenerate the project's =etags= / =gtags= |
Multiple ways to copy a file path
2018-06-02 15:14:42 +00:00
| ~SPC p h~ | find file |
| ~SPC p I~ | invalidate the projectile cache |
| ~SPC p k~ | kill all project buffers |
| ~SPC p o~ | run =multi-occur= |
| ~SPC p p~ | switch project |
| ~SPC p r~ | open a recent file |
| ~SPC p R~ | replace a string |
Make treemacs the default file browser.
2019-01-19 15:25:26 +00:00
| ~SPC p t~ | open =Treemacs= and add current =projectile= root to its list of projects |
Multiple ways to copy a file path
2018-06-02 15:14:42 +00:00
| ~SPC p T~ | test project |
| ~SPC p v~ | open project root in =vc-dir= or =magit= |
| ~SPC /~ | search in project with the best search tool available |
documentation formatting: Sun Jan 20 15:34:11 UTC 2019
2019-01-20 15:34:11 +00:00
| ~SPC s p~ | see [[#searching-in-a-project][searching in a project]] |
Multiple ways to copy a file path
2018-06-02 15:14:42 +00:00
| ~SPC s a p~ | run =ag= |
| ~SPC s g p~ | run =grep= |
| ~SPC s k p~ | run =ack= |
| ~SPC s t p~ | run =pt= |
| ~SPC s r p~ | run =rg= |
Fixes formatting on documentation table
2018-11-12 21:07:49 +00:00
| ~SPC f y C~ | show and copy current file path relative to the project root with line and column number |
| ~SPC f y D~ | show and copy current directory path relative to the project root |
| ~SPC f y L~ | show and copy current file path relative to the project root with line number |
| ~SPC f y Y~ | show and copy current file path relative to the project root |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Disable projectile-caching by default. - Default projectile settings are to disable caching when indexing method is `alien. So setting the indexing method should be enough. - On windows we keep the 'native method unless find is found
2015-11-13 18:38:29 +00:00
*Note for Windows Users*: To enable fast indexing the GNU ~find~ or
Cygwin ~find~ must be in your ~PATH~.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
** Registers
Access commands to the various registers start with =r=:
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
|-------------+------------------------------------|
| ~SPC r e~ | show evil yank and named registers |
| ~SPC r m~ | show marks register |
| ~SPC r r~ | show helm register |
| ~SPC r y~ | show kill ring |
** Errors handling
Doc: replace all occurences of =Spacemacs= by Spacemacs
2015-09-27 14:18:57 +00:00
Spacemacs uses [[https://github.com/flycheck/flycheck][Flycheck]] to gives error feedback on the fly. The checks are
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
only performed at save time by default.
Errors management commands (start with ~e~):
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
|-------------+-----------------------------------------------------------------------|
| ~SPC t s~ | toggle flycheck |
| ~SPC e c~ | clear all errors |
| ~SPC e h~ | describe a flycheck checker |
| ~SPC e l~ | toggle the display of the =flycheck= list of errors/warnings |
| ~SPC e n~ | go to the next error |
| ~SPC e p~ | go to the previous error |
[flycheck] binds flycheck-copy-errors-as-kill to `SPC e y`
2017-03-22 09:00:59 +00:00
| ~SPC e y~ | copy each error at cursor position into kill ring |
First pass to update DOCUMENTATION.org
2016-03-18 02:03:19 +00:00
| ~SPC e v~ | verify flycheck setup (useful to debug 3rd party tools configuration) |
Update documentation
2016-06-08 18:26:35 +00:00
| ~SPC e .~ | error transient state |
The next/previous error bindings and the error transient state can be used to
browse errors from flycheck as well as errors from compilation buffers, and
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
indeed anything that supports Emacs' =next-error= API. This includes for example
Update documentation
2016-06-08 18:26:35 +00:00
search results that have been saved to a separate buffer.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Add 'z' recenter bindings for various transient states By analogy with the "zz", "zb", "zt" vim / evil bindings, this adds an additional key binding "z" for `recenter-top-bottom` to the following transient states which navigate around the buffer in large jumps: - auto-symbol-highlight - error - buffer - vcs - org-babel This allows for repositioning of the buffer for visibility without having to exit the transient state. Minor updates are also made to documentation of other transient states.
2018-10-22 08:09:55 +00:00
*** Error transient state
The following key bindings are active in the error transient state:
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Add 'z' recenter bindings for various transient states By analogy with the "zz", "zb", "zt" vim / evil bindings, this adds an additional key binding "z" for `recenter-top-bottom` to the following transient states which navigate around the buffer in large jumps: - auto-symbol-highlight - error - buffer - vcs - org-babel This allows for repositioning of the buffer for visibility without having to exit the transient state. Minor updates are also made to documentation of other transient states.
2018-10-22 08:09:55 +00:00
|-------------+---------------------------|
| ~n~ | jump to next error |
| ~N~ or ~p~ | jump to previous error |
| ~z~ | recenter buffer in window |
*** Custom fringe bitmaps
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
| Symbol | Description |
|--------------------------+-------------|
| [[file:img/dot-error.png]] | Error |
| [[file:img/dot-warning.png]] | warning |
| [[file:img/dot-info.png]] | Info |
** Compiling
Doc: replace all occurences of =Spacemacs= by Spacemacs
2015-09-27 14:18:57 +00:00
Spacemacs binds a few commands to support compiling a project.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Reformat documentation
2018-09-19 03:54:47 +00:00
|-------------+--------------------------------|
| ~SPC c c~ | use =helm-make= via projectile |
| ~SPC c C~ | compile |
| ~SPC c d~ | close compilation window |
| ~SPC c k~ | kill compilation |
| ~SPC c m~ | =helm-make= |
| ~SPC c r~ | recompile |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
[defaults] add qickrun bind it to `SPC x x`, not sure it's the right place but it's easy to invoke
2021-04-12 04:47:02 +00:00
** Quickrun
Spacemacs can execute current buffer or region.
| Key binding | Description |
|-------------+---------------------------------------------------|
| ~SPC x x~ | smart =quickrun= or =quickrun-region= |
| ~C-g~ | to dismiss a quickrun buffer without selecting it |
[docs] Mention EditorConfig support Fixes #8960
2017-05-25 19:20:03 +00:00
* EditorConfig
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
Spacemacs has support for [[http://editorconfig.org/][EditorConfig]], a configuration file to "define and
maintain consistent coding styles between different editors and IDEs."
[docs] Mention EditorConfig support Fixes #8960
2017-05-25 19:20:03 +00:00
To enable this feature, [[https://github.com/editorconfig/editorconfig-core-c/blob/master/INSTALL.md][install the editorconfig command]].
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
To customize your editorconfig experience, read [[https://github.com/editorconfig/editorconfig-emacs/blob/master/README.md#customize][the editorconfig-emacs package's
Format editorconfig documentation
2017-05-26 08:46:51 +00:00
documentation]].
[docs] Mention EditorConfig support Fixes #8960
2017-05-25 19:20:03 +00:00
doc: fix nesting
2017-04-10 04:07:10 +00:00
* Emacs Server
Modify documentation to reflect that Emacs server is off by default Pull request #10297 made the Emacs server optional, so that it does not start up unless the init file is modified to enable it. The documentation, however, indicates that the opposite is true. This fix updates the documentation to be consistent with the actual behavior.
2020-10-21 11:10:12 +00:00
Spacemacs provides the ability to start a server at launch, and to kill that
server whenever you close your Emacs windows. This can be enabled by setting the
variable =dotspacemacs-enable-server= to =t= in your =~./spacemacs=.
#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-enable-server t)
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
doc: fix nesting
2017-04-10 04:07:10 +00:00
** Connecting to the Emacs server
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
You can open a file in Emacs from the terminal using =emacsclient=. Use
=emacsclient -c= to open the file in Emacs GUI. Use =emacsclient -t= to open the
Add documentation about specify socket server for client
2018-06-15 06:58:49 +00:00
file in Emacs within the terminal. If you set Emacs server socket by setting =dotspacemacs-server-socket-dir=,
then pass its location as =-s ~/.emacs.d/server/server= additionally.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Update references to macOS Apple renamed "Mac OS X" to "OS X" in 2012 and then to "macOS" in 2016. Update references to use the current name.
2019-10-13 05:27:17 +00:00
If you want your Linux or macOS system to use Emacs by default for any prompt,
you need to set it in your shell configuration, e.g. =~/.bashrc= or =~/.zshrc=:
Fix documentation for emacsclient Verbatim text with equal sign was't displaying correctly. Another solution would be to escape `=` with Org mode entity, but GitHub won't display it correctly.
2015-09-13 11:16:40 +00:00
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+BEGIN_SRC sh-mode
Reformat documentation
2018-09-19 03:54:47 +00:00
export EDITOR="emacsclient -c"
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Update references to macOS Apple renamed "Mac OS X" to "OS X" in 2012 and then to "macOS" in 2016. Update references to use the current name.
2019-10-13 05:27:17 +00:00
Note that if you're using macOS, you may have to refer to the emacsclient that
comes with your GUI Emacs, e.g.:
Fix documentation for emacsclient Verbatim text with equal sign was't displaying correctly. Another solution would be to escape `=` with Org mode entity, but GitHub won't display it correctly.
2015-09-13 11:16:40 +00:00
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+BEGIN_SRC sh-mode
Reformat documentation
2018-09-19 03:54:47 +00:00
export EDITOR="/Applications/Emacs.app/Contents/MacOS/bin/emacsclient -c"
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Tip: Remember to use ~:wq~ or ~C-x #~ after you are done editing the file in
Emacs.
add a bit of documentation about setting the server socket
2018-03-04 13:44:43 +00:00
You can set the location of the Emacs server socket by setting =dotspacemacs-server-socket-dir= in your =~./spacemacs=:
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(setq-default dotspacemacs-server-socket-dir "~/.emacs/server")
add a bit of documentation about setting the server socket
2018-03-04 13:44:43 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
See [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Emacs-Server.html][Emacs as a Server]] in the official Emacs manual for more details.
** Keeping the server alive
It is possible to keep the server alive when you close Emacs by setting the
fix typo in DOCUMENTATION.org
2017-07-23 09:23:30 +00:00
variable =dotspacemacs-persistent-server= to =t= in your =~/.spacemacs=.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+BEGIN_SRC emacs-lisp
Reformat documentation
2018-09-19 03:54:47 +00:00
(setq-default dotspacemacs-persistent-server t)
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
#+END_SRC
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
When this variable is set to =t=, the only way to quit Emacs /and/ kill the
server is to use the following bindings:
documentation fixes: Tue Oct 23 14:18:21 UTC 2018
2018-10-23 14:18:21 +00:00
| Key binding | Description |
|-------------+--------------------------------------------------------------------------|
| ~SPC q q~ | Quit Emacs and kill the server, prompt for changed buffers to save |
| ~SPC q Q~ | Quit Emacs and kill the server, lose all unsaved changes. |
| ~SPC q r~ | Restart both Emacs and the server, prompting to save any changed buffers |
| ~SPC q s~ | Save the buffers, quit Emacs and kill the server |
| ~SPC q f~ | Kill the current frame |
| ~SPC q t~ | Restart Emacs and debug with --with-timed-requires |
| ~SPC q T~ | Restart Emacs and debug with --adv-timers |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
doc: fix nesting
2017-04-10 04:07:10 +00:00
* Troubleshoot
** Loading fails
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
If any errors happen during the loading the mode-line will turn red and the
errors should appear inline in the startup buffer. Spacemacs should still be
Add small, non-structural fixes to documentation
2016-04-23 06:33:55 +00:00
usable; if it is not then restart Emacs with =emacs --debug-init= and open a
Fix capitalization of GitHub Change instances of "Github" to "GitHub".
2020-01-13 18:12:25 +00:00
[[https://github.com/syl20bnr/spacemacs/issues][GitHub issue]] with the backtrace.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
doc: fix nesting
2017-04-10 04:07:10 +00:00
** Upgrading/Downgrading Emacs version
Add documentation for spacemacs/recompile-elpa
2015-12-21 05:43:35 +00:00
To ensure that packages are correctly compiled for the new Emacs version you
installed, be sure to run the interactive command =spacemacs/recompile-elpa=
spacemacs/recompile-elpa with argument deletes all existing *.elc files Rationale: very often users required to find and delete all *.elc files manually. That's a bit tedious.
2019-06-12 17:38:46 +00:00
with ~SPC u SPC SPC spacemacs/recompile-elpa~.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
[doc] Add more detailed troubleshooting information
2019-08-28 21:53:26 +00:00
** General layer errors
It happens from time to time that some of the layers go stale and stop
working properly for some commands. If this happens stay calm and try
Fix capitalization of GitHub Change instances of "Github" to "GitHub".
2020-01-13 18:12:25 +00:00
to produce a minimal bug report on the [[https://github.com/syl20bnr/spacemacs/issues][GitHub issue page]].
[doc] Add more detailed troubleshooting information
2019-08-28 21:53:26 +00:00
*** Step by step instructions for minimal layer bug reports
- Load the standard dotfile. You can get it with ~SPC f e D~.
- Add the malfunctioning layer.
- Use ~SPC t D~ to enable debug on error, this will
produce a backtrace when encountering a lisp error.
- Reproduce the error. Note down the steps and backtrace.
- Press ~SPC h I~ and fill in the place holders
enclosed in ~<<~ and ~>>~ signs. Don't forget the
reproduction guide and backtrace.
- Press ~C-c C-c~ or ~, ,~ to transfer your buffers
content to the github issue creation page.
- Enter a meaningfull title for your issue, stating
in short words what the issue is.
- When everything has been filled in submit the bug
report.
- When someone answers to your issue or ask questions
it goes without saying that you should answer him
politely and assist in testing a possible fix.
** General emacs package errors
It can also happen that your issue is not related to any layer but
rather to a specific package in the emacs universe. In this case
you should provide a minimalistic emacs only reproduction guide for the
respective package and open an issue upstream. If there is already
a spacemacs issue for your problem your upstream bug report should
mention its ticket number so it is clear when this issue can be
retested.
*** Step by step instructions for minimal emacs package bug reports
- Start emacs with ~emacs -q~, this will load a vanilla
emacs without any non-system packages loaded.
- There open a scratch buffer with ~C-x b *scratch* RET~
- Add initialization code for your package there
#+BEGIN_SRC elisp
documentation formatting: Thu Aug 29 23:13:44 UTC 2019
2019-08-29 23:13:44 +00:00
;; Load the package
(require 'package)
[doc] Add more detailed troubleshooting information
2019-08-28 21:53:26 +00:00
documentation formatting: Thu Aug 29 23:13:44 UTC 2019
2019-08-29 23:13:44 +00:00
;; Mention all packages you wish to have loaded
(setq package-load-list
'((package1 t)
(package2 t)
(package3 t)))
[doc] Add more detailed troubleshooting information
2019-08-28 21:53:26 +00:00
documentation formatting: Thu Aug 29 23:13:44 UTC 2019
2019-08-29 23:13:44 +00:00
;; Do package specific configuration if required
;; (package-local-init)
[doc] Add more detailed troubleshooting information
2019-08-28 21:53:26 +00:00
documentation formatting: Thu Aug 29 23:13:44 UTC 2019
2019-08-29 23:13:44 +00:00
;; Intialize your package list
(package-initialize)
[doc] Add more detailed troubleshooting information
2019-08-28 21:53:26 +00:00
#+END_SRC
- Now press ~M-x eval-buffer~ to evaluate the code.
- Reproduce your issue. Note down step by step instructions.
- With this information open an upstream issue following
their issue templates. If they have non its a good idea
to start with the infos required in the spacemacs issue
template and add missing information when required from
the package maintainers.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
* Achievements
** Issues
Format documenation files with doc-fmt tool
2016-04-13 03:31:38 +00:00
Add achievements 8000th issue goes to jonbash 9000th issue goes to shaunpatel 10000th issue goes to nikital
2018-01-07 03:40:16 +00:00
| Achievements | Account |
|--------------------------------+--------------|
| [[https://github.com/syl20bnr/spacemacs/pull/100][100th issue (PR)]] | [[https://github.com/danielwuz][danielwuz]] |
| [[https://github.com/syl20bnr/spacemacs/issues/200][200th issue (question)]] | [[https://github.com/justrajdeep][justrajdeep]] |
| [[https://github.com/syl20bnr/spacemacs/pull/300][300th issue (PR)]] | [[https://github.com/danielwuz][danielwuz]] |
| [[https://github.com/syl20bnr/spacemacs/pull/400][400th issue (PR)]] | [[https://github.com/CestDiego][CestDiego]] |
| [[https://github.com/syl20bnr/spacemacs/pull/500][500th issue (PR)]] | [[https://github.com/bjarkevad][bjarkevad]] |
| [[https://github.com/syl20bnr/spacemacs/pull/600][600th issue (PR)]] | [[https://github.com/bjarkevad][bjarkevad]] |
| [[https://github.com/syl20bnr/spacemacs/pull/700][700th issue (enhancement)]] | [[https://github.com/jcpetkovich][jcpetkovich]] |
| [[https://github.com/syl20bnr/spacemacs/pull/800][800th issue (PR)]] | [[https://github.com/laat][ryansroberts]] |
| [[https://github.com/syl20bnr/spacemacs/pull/900][900th issue (PR)]] | [[https://github.com/jcpetkovich][jcpetkovich]] |
| [[https://github.com/syl20bnr/spacemacs/pull/1000][1000th issue (PR)]] | [[https://github.com/tuhdo][tuhdo]] |
| [[https://github.com/syl20bnr/spacemacs/pull/2000][2000th issue (PR)]] | [[https://github.com/IvanMalison][IvanMalison]] |
| [[https://github.com/syl20bnr/spacemacs/issues/3000][3000th issue (bug)]] | [[https://github.com/malchmih][malchmih]] |
| [[https://github.com/syl20bnr/spacemacs/issues/4000][4000th issue (bug)]] | [[https://github.com/icymist][icymist]] |
| [[https://github.com/syl20bnr/spacemacs/issues/5000][5000th issue (too many issues)]] | [[https://github.com/justbur][justbur]] |
| [[https://github.com/syl20bnr/spacemacs/pull/6000][6000th issue (PR)]] | [[https://github.com/d12frosted][d12frosted]] |
| [[https://github.com/syl20bnr/spacemacs/pull/7000][7000th issue (PR)]] | [[https://github.com/deb0ch][deb0ch]] |
[doc] Fix links
2021-04-13 09:38:33 +00:00
| [[https://github.com/syl20bnr/spacemacs/issues/8000][8000th issue (bug)]] | jonbash |
Add achievements 8000th issue goes to jonbash 9000th issue goes to shaunpatel 10000th issue goes to nikital
2018-01-07 03:40:16 +00:00
| [[https://github.com/syl20bnr/spacemacs/issues/9000][9000th issue (bug)]] | [[https://github.com/shaunpatel][shaunpatel]] |
| [[https://github.com/syl20bnr/spacemacs/pull/10000][10000th issue (PR)]] | [[https://github.com/nikital][nikital]] |
Add achievements 3000th issue: malchmih 4000th issue: icymist 2000th merged PR: channingwalton
2015-12-08 04:43:46 +00:00
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
** Merged Pull Requests
Format documenation files with doc-fmt tool
2016-04-13 03:31:38 +00:00
Add achievements 3000th issue: malchmih 4000th issue: icymist 2000th merged PR: channingwalton
2015-12-08 04:43:46 +00:00
| Achievements | Account |
|---------------------+----------------|
| [[https://github.com/syl20bnr/spacemacs/pull/228][100th pull request]] | [[https://github.com/bru][bru]] |
| [[https://github.com/syl20bnr/spacemacs/pull/418][200th pull request]] | [[https://github.com/smt][smt]] |
| [[https://github.com/syl20bnr/spacemacs/pull/617][300th pull request]] | [[https://github.com/BrianHicks][BrianHicks]] |
| [[https://github.com/syl20bnr/spacemacs/pull/806][400th pull request]] | [[https://github.com/cpaulik][cpaulik]] |
| [[https://github.com/syl20bnr/spacemacs/pull/993][500th pull request]] | [[https://github.com/tuhdo][tuhdo]] |
| [[https://github.com/syl20bnr/spacemacs/pull/1205][600th pull request]] | [[https://github.com/trishume][trishume]] |
| [[https://github.com/syl20bnr/spacemacs/pull/1995][1000th pull request]] | [[https://github.com/justbur][justbur]] |
| [[https://github.com/syl20bnr/spacemacs/pull/4089][2000th pull request]] | [[https://github.com/channingwalton][channingwalton]] |
Add 3000th PR achievement Goes to darkfeline.
2016-07-07 01:57:39 +00:00
| [[https://github.com/syl20bnr/spacemacs/pull/6338][3000th pull request]] | [[https://github.com/darkfeline][darkfeline]] |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
** Stars, forks and watchers
Format documenation files with doc-fmt tool
2016-04-13 03:31:38 +00:00
Add 15000th star achievement Goes to missingfaktor
2018-05-21 04:16:33 +00:00
| Achievements | Account |
|----------------------------+-----------------|
| 100th watcher | [[https://github.com/adouzzy][adouzzy]] |
| 100th fork | [[https://github.com/balajisivaraman][balajisivaraman]] |
| 200th fork | [[https://github.com/alcol80][alcol80]] |
| 300th fork | [[https://github.com/mlopes][mlopes]] |
| 2000th fork | [[https://github.com/Gameguykiler][Gameguykiler]] |
| 100th star | [[https://github.com/Jackneill][Jackneill]] |
| 200th star | [[https://github.com/jb55][jb55]] |
| 400th star | [[https://github.com/dbohdan][dbohdan]] |
| 600th star | [[https://github.com/laat][laat]] |
| 700th star | [[https://github.com/kendall][kendall]] |
| 800th star | [[https://github.com/urso][urso]] |
| 900th star | [[https://github.com/luisgerhorst][luisgerhorst]] |
| 1000th star! | [[https://github.com/rashly][rashly]] |
| 2000th star!! | [[https://github.com/stshine][stshine]] |
| 3000th star!!! | [[https://github.com/TheBB][TheBB]] |
| 4000th star!!!! | [[https://github.com/nixmaniack][nixmaniack]] |
| 5000th star!!!!! | [[https://github.com/StreakyCobra][StreakyCobra]] |
| 6000th star!!!!!! | [[https://github.com/NJBS][NJBS]] |
| 7000th star!!!!!!! | [[https://github.com/mukhali][mukhali]] |
| 8000th star!!!!!!!! | [[https://github.com/shsteven][shsteven]] |
| 9000th star!!!!!!!!! | [[https://github.com/deb0ch][deb0ch]] |
| 10000th star :star: | [[https://github.com/colt365][colt365]] |
| 15000th star :star: :star: | [[https://github.com/missingfaktor][missingfaktor]] |
documentation formatting: Sat May 16 21:43:42 UTC 2020
2020-05-16 21:43:42 +00:00
| 20000th star! :scream_cat: | [[https://github.com/davehorner][davehorner]] |
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Add achievements 1000th PR to justbur 2000th star to stshine 1000th joiner on the chat to gabrielpoca 1st joiner on the chat to trishume
2015-07-02 04:37:04 +00:00
** Gitter chat
Format documenation files with doc-fmt tool
2016-04-13 03:31:38 +00:00
Add achievements 3000th star to TheBB The Master of the Keys to justbur The PR Patrol Officer to robbyoconnor
2015-08-11 05:48:40 +00:00
| Achievements | Account |
|---------------------------------+-------------|
| First joiner on the Gitter Chat | [[https://github.com/trishume][trishume]] |
| 1000th joiner | [[https://github.com/gabrielpoca][gabrielpoca]] |
Add achievements 1000th PR to justbur 2000th star to stshine 1000th joiner on the chat to gabrielpoca 1st joiner on the chat to trishume
2015-07-02 04:37:04 +00:00
** First times
Format documenation files with doc-fmt tool
2016-04-13 03:31:38 +00:00
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
| Achievements | Account |
|---------------------------------+--------------|
| [[https://github.com/syl20bnr/spacemacs/pull/19][First contribution]] | [[https://github.com/trishume][trishume]] |
Remove old wording "contribution layer"
2017-08-28 15:33:55 +00:00
| [[https://github.com/syl20bnr/spacemacs/commit/e802027d75d0c0aed55539b0da2dfa0df94dfd39][First contributed layer]] | [[https://github.com/trishume][trishume]] |
Fix spacefmt test on deleted files Also fix some links [ci skip]
2017-04-26 13:50:19 +00:00
| [[http://oli.me.uk/2014/11/06/spacemacs-emacs-vim/][First blog article on Spacemacs]] | Wolfy87 |
Convert documentation to publishable format
2015-10-30 11:20:58 +00:00
| [[https://github.com/syl20bnr/spacemacs/commit/7b44a56263049482ed540ed6815a295633ffe9d1][First contributed banner]] | [[https://github.com/chrisbarrett][chrisbarrett]] |
Add achievements 1000th PR to justbur 2000th star to stshine 1000th joiner on the chat to gabrielpoca 1st joiner on the chat to trishume
2015-07-02 04:37:04 +00:00
Add new achievements New section Special Mentions, first mentions attributed to: StreakyCobra justbur CestDiego JAremko Rename Special section to Special Titles Give The Librarian special title to JAremko
2016-04-13 03:53:18 +00:00
** Special Mentions
Add some achievements justbur d12frosted deb0ch shsteven JAremko TheBB travisbhartwell
2016-09-06 01:47:00 +00:00
| Reason | Account |
|---------------------------------------------------------------------+-----------------|
| Autumnal Cleanup 2015 ([[https://github.com/syl20bnr/spacemacs/wiki/Autumnal-Cleanup-2015][wiki]]) | [[https://github.com/StreakyCobra][StreakyCobra]] |
| Test and debug tools | [[https://github.com/justbur][justbur]] |
| Integration of Ivy | [[https://github.com/justbur][justbur]] |
| Transient States | [[https://github.com/justbur][justbur]] |
| Integration of Persp-mode | [[https://github.com/CestDiego][CestDiego]] |
| Cleanest PR ([[https://github.com/syl20bnr/spacemacs/pull/5545][PR #5545]]) | [[https://github.com/JAremko][JAremko]] |
| Documentation tools and GitHub support | [[https://github.com/JAremko][JAremko]] |
| Code navigation improvement (jump handlers, generalized next error) | [[https://github.com/TheBB][TheBB]] |
| Better support for GUI using an Emacs daemon (after-display macro) | [[https://github.com/travisbhartwell][travisbhartwell]] |
Add new achievements New section Special Mentions, first mentions attributed to: StreakyCobra justbur CestDiego JAremko Rename Special section to Special Titles Give The Librarian special title to JAremko
2016-04-13 03:53:18 +00:00
** Special Titles
Format documenation files with doc-fmt tool
2016-04-13 03:31:38 +00:00
Add smile12341234 to the achievement, he is The Orgonaut!
2018-02-28 04:08:11 +00:00
| Achievements | Account |
|-------------------------------------------------+---------------|
| The Gunner (18 PRs in a row) | [[https://github.com/ralesi][ralesi]] |
| The Saint (unlocked the holy-mode) | [[https://github.com/trishume][trishume]] |
| The Artist ([[https://github.com/nashamri/spacemacs-logo][logo]] and [[https://github.com/nashamri/spacemacs-theme][theme]]) | [[https://github.com/nashamri][nashamri]] |
| The Meme Master (doge banner) | [[https://github.com/chrisbarrett][chrisbarrett]] |
| The Helm captain ([[https://tuhdo.github.io/helm-intro.html][helm guide]]) | [[https://github.com/tuhdo][tuhdo]] |
| The Master of the Keys ([[https://github.com/justbur/emacs-which-key][which-key]] and [[https://github.com/justbur/emacs-bind-map][bind-map]]) | [[https://github.com/justbur][justbur]] |
| The PR Patrol Officer | [[https://github.com/robbyoconnor][robbyoconnor]] |
| The Expert in Latin Language ([[https://github.com/syl20bnr/spacemacs/pull/4043][PR]]) | [[https://github.com/vijaykiran][vijaykiran]] |
| The Tiler ([[https://github.com/syl20bnr/spacemacs/pull/4068][eyebrowse integration]]) | [[https://github.com/bmag][bmag]] |
| The Geometer ([[https://github.com/TheBB/spaceline][spaceline]]) | [[https://github.com/TheBB][TheBB]] |
| The Librarian (doc-fmt tool and space-doc mode) | [[https://github.com/JAremko][JAremko]] |
| The Orgonaut ([[https://github.com/syl20bnr/spacemacs/issues/9476][fixed most of the Org READMEs]]) | [[https://github.com/smile13241324][smile13241324]] |
add a special title for StreakyCobra
2018-10-09 04:07:27 +00:00
| The Ticketmaster | [[https://github.com/StreakyCobra][StreakyCobra]] |
add a special title for JAremko
2018-10-09 04:15:00 +00:00
| The ASCII Scribe | [[https://github.com/JAremko][JAremko]] |
Add new achievements New section Special Mentions, first mentions attributed to: StreakyCobra justbur CestDiego JAremko Rename Special section to Special Titles Give The Librarian special title to JAremko
2016-04-13 03:53:18 +00:00
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
* Thank you
Fix broken links in the docs
2016-08-03 13:18:45 +00:00
Thank you Richard for this great piece of software.
Convert DOCUMENTATION.md to org.
2015-06-11 05:00:54 +00:00
Thank you to all the contributors and the whole Emacs community from core
developers to elisp hackers!
Reference in a new issue Copy permalink