From bd71237db1796b8cf50cfb5d046f8477697ef1f9 Mon Sep 17 00:00:00 2001 From: Fabien Dubosson Date: Tue, 6 Oct 2015 22:17:48 +0200 Subject: [PATCH] Update the FAQ This commit apply the following changes: - Remove leading whitespaces - Apply fill-paragraph to justify answers' paragraphs. - Add question: how to define/change an evil-leader prefix? - Add question: user-init or user-config? --- doc/FAQ.org | 66 +++++++++++++++++++++++++++++++++++------------------ 1 file changed, 44 insertions(+), 22 deletions(-) diff --git a/doc/FAQ.org b/doc/FAQ.org index 9bd1bb1ca..6299e8efa 100644 --- a/doc/FAQ.org +++ b/doc/FAQ.org @@ -8,6 +8,8 @@ - [[#the-powerline-separators-have-no-anti-aliasing-what-can-i-do-][The powerline separators have no anti-aliasing, what can I do ?]] - [[#why-is-after-init-hook-not-executed-][Why is after-init-hook not executed ?]] - [[#what-is-the-difference-between-spacemacs-base-and-spacemacs-distributions-][What is the difference between =spacemacs-base= and =spacemacs= distributions ?]] + - [[#how-can-i-change-or-define-an-alias-for-an-evil-leader-prefix-][How can I change or define an alias for an =evil-leader= prefix ?]] + - [[#should-i-place-my-settings-in-user-init-or-user-config][Should I place my settings in =user-init= or =user-config=?]] - [[#why-do-some-of-my-org-related-settings-cause-problems][Why do some of my =org=-related settings cause problems?]] - [[#windows][Windows]] - [[#why-do-the-fonts-look-crappy-on-windows-][Why do the fonts look crappy on Windows ?]] @@ -18,44 +20,64 @@ ** Common *** Which version of Spacemacs am I running ? -The version is displayed on the upper right corner of the loading screen. -You may also just type ~SPC f e v~. +The version is displayed on the upper right corner of the loading screen. You +may also just type ~SPC f e v~. *** What is the official pronunciation of Spacemacs ? As it is written, that is _space_ then _macs_. *** Why are packages installed with =package-install= automatically deleted by Spacemacs when it boots ? -To declare new packages you have to create a new configuration layer, see -the [[file:QUICK_START.org][quick start guide]]. +To declare new packages you have to create a new configuration layer, see the +[[file:QUICK_START.org][quick start guide]]. *** The Spacemacs banner is ugly, what should I do ? Install the default font supported by Spacemacs or choose a fixed width font. More information in the font section of the [[file:DOCUMENTATION.org][documentation]]. *** The powerline separators are ugly, how can I fix them ? -Use the property =:powerline-scale= of the variable -=dotspacemacs-default-font=. See font section of the [[file:DOCUMENTATION.org][documentation]] for more details. +Use the property =:powerline-scale= of the variable =dotspacemacs-default-font=. +See font section of the [[file:DOCUMENTATION.org][documentation]] for more details. *** The powerline separators have no anti-aliasing, what can I do ? Emacs powerline uses XMP images to draw the separators in a graphical -environment. You can have anti-aliasing if you use the =utf8= separator. -Note that by default the =utf8= separator is used in a terminal. -See the powerline section in the font section of the [[file:DOCUMENTATION.org][documentation]]. +environment. You can have anti-aliasing if you use the =utf8= separator. Note +that by default the =utf8= separator is used in a terminal. See the powerline +section in the font section of the [[file:DOCUMENTATION.org][documentation]]. *** Why is after-init-hook not executed ? -Don't launch Spacemacs with =emacs -q -l init.el= command. This command will -run the hooked function in =after-init-hook= before the evaluation of the -passed =-l init.el= file. +Don't launch Spacemacs with =emacs -q -l init.el= command. This command will run +the hooked function in =after-init-hook= before the evaluation of the passed =-l +init.el= file. *** What is the difference between =spacemacs-base= and =spacemacs= distributions ? - The =distribution= concept was introduced in 0.104.x. You can now choose - between two distributions =spacemacs= or =spacemacs-base=. - =spacemacs-base= contains only a minimal set of packages; whereas =spacemacs= - is the full Spacemacs experience. - Set the distribution with =dotspacemacs-distribution= variable. The default is - =spacemacs=. For more information as to what is included, - check out the =packages.el= file in the respective folders in the - =+distribution= folder of the =layers/= directory. +The =distribution= concept was introduced in 0.104.x. You can now choose +between two distributions =spacemacs= or =spacemacs-base=. +=spacemacs-base= contains only a minimal set of packages; whereas =spacemacs= +is the full Spacemacs experience. +Set the distribution with =dotspacemacs-distribution= variable. The default is +=spacemacs=. For more information as to what is included, +check out the =packages.el= file in the respective folders in the +=+distribution= folder of the =layers/= directory. + +*** How can I change or define an alias for an =evil-leader= prefix ? +It is possible to change an =evil-leader= prefix by binding its keymap to +another sequence. For instance, if you want to switch ~SPC l~ +(=evil-avy-goto-line=) with ~SPC L~ (=perspectives= layer) to make the later +easier to reach, you can use: + +#+begin_src emacs-lisp +(evil-leader/set-key + "l" (lookup-key evil-leader--default-map "L") + "L" 'evil-avy-goto-line) +#+end_src + +*** Should I place my settings in =user-init= or =user-config=? + +Any variable that layer configuration code will *read* and *act on* must be set +in =user-init=, and any variable that Spacemacs explicitly sets but you wish to +*override* must be set in =user-config=. + +Anything that isn't just setting a variable should 99% be in =user-config=. *** Why do some of my =org=-related settings cause problems? Since version 0.104, spacemacs uses the `org` version from the org ELPA @@ -86,5 +108,5 @@ directory as Emacs. See [[https://www.gnu.org/software/emacs/manual/html_mono/em ** OS X *** Why are the powerline colors not correct on OS X ? This is a [[https://github.com/milkypostman/powerline/issues/54][known issue]] as of Emacs 24.4 due to =ns-use-srgb-colorspace= -defaulting to true. It is recommended to use the [[github.com/railwaycat/homebrew-emacsmacport][emacs-mac-port]] build. -See the install section in the [[file:../README.md][README]] for more details. +defaulting to true. It is recommended to use the [[github.com/railwaycat/homebrew-emacsmacport][emacs-mac-port]] build. See the +install section in the [[file:../README.md][README]] for more details.