diff --git a/spacemacs b/spacemacs index 8f88dc7..ace4415 100644 --- a/spacemacs +++ b/spacemacs @@ -48,8 +48,9 @@ (add-to-list 'ttm-layers 'osx))) (defun dotspacemacs/layers () - "Layer configuration: -This function should only modify configuration layer settings." + "Configuration Layers declaration. +You should not put any user code in this function besides modifying the variable +values." (setq-default ;; Base distribution to use. This is a layer contained in the directory ;; `+distribution'. For now available distributions are `spacemacs-base' @@ -85,22 +86,23 @@ This function should only modify configuration layer settings." dotspacemacs-excluded-packages '() ;; Defines the behaviour of Spacemacs when installing packages. ;; Possible values are `used-only', `used-but-keep-unused' and `all'. - ;; `used-only' installs only explicitly used packages and deletes any unused - ;; packages as well as their unused dependencies. `used-but-keep-unused' - ;; installs only the used packages but won't delete unused ones. `all' - ;; installs *all* packages supported by Spacemacs and never uninstalls them. - ;; (default is `used-only') + ;; `used-only' installs only explicitly used packages and uninstall any + ;; unused packages as well as their unused dependencies. + ;; `used-but-keep-unused' installs only the used packages but won't uninstall + ;; them if they become unused. `all' installs *all* packages supported by + ;; Spacemacs and never uninstall them. (default is `used-only') dotspacemacs-install-packages 'used-only)) (defun dotspacemacs/init () - "Initialization: -This function is called at the very beginning of Spacemacs startup, -before layer configuration. -It should only modify the values of Spacemacs settings." + "Initialization function. +This function is called at the very startup of Spacemacs initialization +before layers configuration. +You should not put any user code in there besides modifying the variable +values." ;; This setq-default sexp is an exhaustive list of all the supported ;; spacemacs settings. (setq-default - ;; If non-nil ELPA repositories are contacted via HTTPS whenever it's + ;; If non nil ELPA repositories are contacted via HTTPS whenever it's ;; possible. Set it to nil if you have no way to use HTTPS in your ;; environment, otherwise it is strongly recommended to let it set to t. ;; This variable has no effect if Emacs is launched with the parameter @@ -108,24 +110,16 @@ It should only modify the values of Spacemacs settings." ;; (default t) dotspacemacs-elpa-https t ;; Maximum allowed time in seconds to contact an ELPA repository. - ;; (default 5) dotspacemacs-elpa-timeout 5 - ;; If non-nil then Spacelpa repository is the primary source to install - ;; a locked version of packages. If nil then Spacemacs will install the lastest - ;; version of packages from MELPA. (default nil) - dotspacemacs-use-spacelpa nil - ;; If non-nil then verify the signature for downloaded Spacelpa archives. - ;; (default nil) - dotspacemacs-verify-spacelpa-archives nil - ;; If non-nil then spacemacs will check for updates at startup + ;; If non nil then spacemacs will check for updates at startup ;; when the current branch is not `develop'. Note that checking for ;; new versions works via git commands, thus it calls GitHub services ;; whenever you start Emacs. (default nil) dotspacemacs-check-for-update nil ;; If non-nil, a form that evaluates to a package directory. For example, to ;; use different package directories for different Emacs versions, set this - ;; to `emacs-version'. (default 'emacs-version) - dotspacemacs-elpa-subdirectory 'emacs-version + ;; to `emacs-version'. + dotspacemacs-elpa-subdirectory nil ;; One of `vim', `emacs' or `hybrid'. ;; `hybrid' is like `vim' except that `insert state' is replaced by the ;; `hybrid state' with `emacs' key bindings. The value can also be a list @@ -133,7 +127,7 @@ It should only modify the values of Spacemacs settings." ;; section of the documentation for details on available variables. ;; (default 'vim) dotspacemacs-editing-style 'vim - ;; If non-nil output loading progress in `*Messages*' buffer. (default nil) + ;; If non nil output loading progress in `*Messages*' buffer. (default nil) dotspacemacs-verbose-loading nil ;; Specify the startup banner. Default value is `official', it displays ;; the official spacemacs logo. An integer value is the index of text @@ -145,17 +139,17 @@ It should only modify the values of Spacemacs settings." ;; List of items to show in startup buffer or an association list of ;; the form `(list-type . list-size)`. If nil then it is disabled. ;; Possible values for list-type are: - ;; `recents' `bookmarks' `projects' `agenda' `todos'. + ;; `recents' `bookmarks' `projects' `agenda' `todos'." ;; List sizes may be nil, in which case ;; `spacemacs-buffer-startup-lists-length' takes effect. dotspacemacs-startup-lists '((recents . 5) (projects . 7)) - ;; True if the home buffer should respond to resize events. (default t) + ;; True if the home buffer should respond to resize events. dotspacemacs-startup-buffer-responsive t ;; Default major mode of the scratch buffer (default `text-mode') dotspacemacs-scratch-mode 'text-mode ;; List of themes, the first of the list is loaded when spacemacs starts. - ;; Press `SPC T n' to cycle to the next theme in the list (works great + ;; Press T n to cycle to the next theme in the list (works great ;; with 2 themes variants, one dark and one light) dotspacemacs-themes '(spacemacs-dark) ;; If non nil the cursor color matches the state color in GUI Emacs. @@ -167,9 +161,9 @@ It should only modify the values of Spacemacs settings." :weight normal :width normal :powerline-scale 1.1) - ;; The leader key (default "SPC") + ;; The leader key dotspacemacs-leader-key "SPC" - ;; The key used for Emacs commands `M-x' (after pressing on the leader key). + ;; The key used for Emacs commands (M-x) (after pressing on the leader key). ;; (default "SPC") dotspacemacs-emacs-command-key "SPC" ;; The key used for Vim Ex commands (default ":") @@ -184,34 +178,31 @@ It should only modify the values of Spacemacs settings." ;; (default "C-M-m") dotspacemacs-major-mode-emacs-leader-key "C-:" ;; These variables control whether separate commands are bound in the GUI to - ;; the key pairs `C-i', `TAB' and `C-m', `RET'. - ;; Setting it to a non-nil value, allows for separate commands under `C-i' - ;; and TAB or `C-m' and `RET'. + ;; the key pairs C-i, TAB and C-m, RET. + ;; Setting it to a non-nil value, allows for separate commands under + ;; and TAB or and RET. ;; In the terminal, these pairs are generally indistinguishable, so this only ;; works in the GUI. (default nil) dotspacemacs-distinguish-gui-tab nil - ;; If non-nil `Y' is remapped to `y$' in Evil states. (default nil) + ;; If non nil `Y' is remapped to `y$' in Evil states. (default nil) dotspacemacs-remap-Y-to-y$ nil ;; If non-nil, the shift mappings `<' and `>' retain visual state if used ;; there. (default t) dotspacemacs-retain-visual-state-on-shift t - ;; If non-nil, `J' and `K' move lines up and down when in visual mode. + ;; If non-nil, J and K move lines up and down when in visual mode. ;; (default nil) dotspacemacs-visual-line-move-text nil - ;; If non-nil, inverse the meaning of `g' in `:substitute' Evil ex-command. + ;; If non nil, inverse the meaning of `g' in `:substitute' Evil ex-command. ;; (default nil) dotspacemacs-ex-substitute-global nil ;; Name of the default layout (default "Default") dotspacemacs-default-layout-name "Default" - ;; If non-nil the default layout name is displayed in the mode-line. + ;; If non nil the default layout name is displayed in the mode-line. ;; (default nil) dotspacemacs-display-default-layout nil - ;; If non-nil then the last auto saved layouts are resumed automatically upon + ;; If non nil then the last auto saved layouts are resume automatically upon ;; start. (default nil) dotspacemacs-auto-resume-layouts nil - ;; If non-nil, auto-generate layout name when creating new layouts. Only has - ;; effect when using the "jump to layout by number" commands. (default nil) - dotspacemacs-auto-generate-layout-names nil ;; Size (in MB) above which spacemacs will prompt to open the large file ;; literally to avoid performance issues. Opening a file literally means that ;; no major mode or minor modes are active. (default is 1) @@ -223,9 +214,9 @@ It should only modify the values of Spacemacs settings." dotspacemacs-auto-save-file-location 'cache ;; Maximum number of rollback slots to keep in the cache. (default 5) dotspacemacs-max-rollback-slots 5 - ;; If non-nil, `helm' will try to minimize the space it uses. (default nil) + ;; If non nil, `helm' will try to minimize the space it uses. (default nil) dotspacemacs-helm-resize nil - ;; if non-nil, the helm header is hidden when there is only one source. + ;; if non nil, the helm header is hidden when there is only one source. ;; (default nil) dotspacemacs-helm-no-header nil ;; define the position to display `helm', options are `bottom', `top', @@ -236,9 +227,8 @@ It should only modify the values of Spacemacs settings." ;; source settings. Else, disable fuzzy matching in all sources. ;; (default 'always) dotspacemacs-helm-use-fuzzy 'always - ;; If non-nil, the paste transient-state is enabled. While enabled, pressing - ;; `p' several times cycles through the elements in the `kill-ring'. - ;; (default nil) + ;; If non nil the paste micro-state is enabled. When enabled pressing `p` + ;; several times cycle between the kill ring content. (default nil) dotspacemacs-enable-paste-transient-state nil ;; Which-key delay in seconds. The which-key buffer is the popup listing ;; the commands bound to the current keystroke sequence. (default 0.4) @@ -248,23 +238,17 @@ It should only modify the values of Spacemacs settings." ;; right; if there is insufficient space it displays it at the bottom. ;; (default 'bottom) dotspacemacs-which-key-position 'bottom - ;; Control where `switch-to-buffer' displays the buffer. If nil, - ;; `switch-to-buffer' displays the buffer in the current window even if - ;; another same-purpose window is available. If non-nil, `switch-to-buffer' - ;; displays the buffer in a same-purpose window even if the buffer can be - ;; displayed in the current window. (default nil) - dotspacemacs-switch-to-buffer-prefers-purpose nil - ;; If non-nil a progress bar is displayed when spacemacs is loading. This + ;; If non nil a progress bar is displayed when spacemacs is loading. This ;; may increase the boot time on some systems and emacs builds, set it to ;; nil to boost the loading time. (default t) dotspacemacs-loading-progress-bar t - ;; If non-nil the frame is fullscreen when Emacs starts up. (default nil) + ;; If non nil the frame is fullscreen when Emacs starts up. (default nil) ;; (Emacs 24.4+ only) dotspacemacs-fullscreen-at-startup nil - ;; If non-nil `spacemacs/toggle-fullscreen' will not use native fullscreen. + ;; If non nil `spacemacs/toggle-fullscreen' will not use native fullscreen. ;; Use to disable fullscreen animations in OSX. (default nil) dotspacemacs-fullscreen-use-non-native nil - ;; If non-nil the frame is maximized when Emacs starts up. + ;; If non nil the frame is maximized when Emacs starts up. ;; Takes effect only if `dotspacemacs-fullscreen-at-startup' is nil. ;; (default nil) (Emacs 24.4+ only) dotspacemacs-maximized-at-startup nil @@ -276,13 +260,13 @@ It should only modify the values of Spacemacs settings." ;; the transparency level of a frame when it's inactive or deselected. ;; Transparency can be toggled through `toggle-transparency'. (default 90) dotspacemacs-inactive-transparency 90 - ;; If non-nil show the titles of transient states. (default t) + ;; If non nil show the titles of transient states. (default t) dotspacemacs-show-transient-state-title t - ;; If non-nil show the color guide hint for transient state keys. (default t) + ;; If non nil show the color guide hint for transient state keys. (default t) dotspacemacs-show-transient-state-color-guide t - ;; If non-nil unicode symbols are displayed in the mode line. (default t) + ;; If non nil unicode symbols are displayed in the mode line. (default t) dotspacemacs-mode-line-unicode-symbols t - ;; If non-nil smooth scrolling (native-scrolling) is enabled. Smooth + ;; If non nil smooth scrolling (native-scrolling) is enabled. Smooth ;; scrolling overrides the default behavior of Emacs which recenters point ;; when it reaches the top or bottom of the screen. (default t) dotspacemacs-smooth-scrolling t @@ -303,7 +287,7 @@ It should only modify the values of Spacemacs settings." ;; Code folding method. Possible values are `evil' and `origami'. ;; (default 'evil) dotspacemacs-folding-method 'evil - ;; If non-nil `smartparens-strict-mode' will be enabled in programming modes. + ;; If non-nil smartparens-strict-mode will be enabled in programming modes. ;; (default nil) dotspacemacs-smartparens-strict-mode nil ;; If non-nil pressing the closing parenthesis `)' key in insert mode passes @@ -314,7 +298,7 @@ It should only modify the values of Spacemacs settings." ;; `current', `all' or `nil'. Default is `all' (highlight any scope and ;; emphasis the current one). (default 'all) dotspacemacs-highlight-delimiters 'all - ;; If non-nil, advise quit functions to keep server open when quitting. + ;; If non nil, advise quit functions to keep server open when quitting. ;; (default nil) dotspacemacs-persistent-server nil ;; List of search tool executable names. Spacemacs uses the first installed @@ -325,40 +309,12 @@ It should only modify the values of Spacemacs settings." ;; specified with an installed package. ;; Not used for now. (default nil) dotspacemacs-default-package-repository nil - ;; Format specification for setting the frame title. - ;; %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 Bot or All - ;; %m - mode name - ;; %n - Narrow if appropriate - ;; %z - mnemonics of buffer, terminal, and keyboard coding systems - ;; %Z - like %z, but including the end-of-line format - ;; (default "%I@%S") - dotspacemacs-frame-title-format "%I@%S" - ;; Format specification for setting the icon title format - ;; (default nil - same as frame-title-format) - dotspacemacs-icon-title-format nil ;; Delete whitespace while saving buffer. Possible values are `all' ;; to aggressively delete empty line and long sequences of whitespace, - ;; `trailing' to delete only the whitespace at end of lines, `changed' to + ;; `trailing' to delete only the whitespace at end of lines, `changed'to ;; delete only whitespace for changed lines or `nil' to disable cleanup. ;; (default nil) dotspacemacs-whitespace-cleanup nil - ;; Either nil or a number of seconds. If non-nil zone out after the specified - ;; number of seconds. (default nil) - dotspacemacs-zone-out-when-idle nil - ;; Run `spacemacs/prettify-org-buffer' when - ;; visiting README.org files of Spacemacs. - ;; (default nil) - dotspacemacs-pretty-docs nil )) (defun dotspacemacs/user-init ()