Emacs config utilizing prelude as a base
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

677 lines
25 KiB

12 years ago
12 years ago
13 years ago
14 years ago
14 years ago
12 years ago
12 years ago
12 years ago
  1. [![License GPL 3][badge-license]](http://www.gnu.org/licenses/gpl-3.0.txt)
  2. [![Gittip](http://img.shields.io/gittip/bbatsov.svg)](https://www.gittip.com/bbatsov/)
  3. Emacs Prelude
  4. =============
  5. Prelude is an Emacs distribution that aims to enhance the default
  6. Emacs experience. Prelude alters a lot of the default settings,
  7. bundles a plethora of additional packages and adds its own core
  8. library to the mix. The final product offers an easy to use Emacs
  9. configuration for Emacs newcomers and lots of additional power for
  10. Emacs power users.
  11. Prelude is compatible **ONLY with GNU Emacs 24.x**. In general you're
  12. advised to always run Prelude with the latest Emacs - currently
  13. **24.3**.
  14. **Table of Contents**
  15. - [Fast Forward](#fast-forward)
  16. - [Installing Emacs 24](#installing-emacs-24)
  17. - [Installation](#installation)
  18. - [Automated](#automated)
  19. - [Via Curl](#via-curl)
  20. - [Via Wget](#via-wget)
  21. - [Manual](#manual)
  22. - [Updating Prelude](#updating-prelude)
  23. - [Manual update](#manual-update)
  24. - [Update all bundled packages](#update-all-bundled-packages)
  25. - [Update Prelude's code](#update-preludes-code)
  26. - [Restart Prelude](#restart-prelude)
  27. - [Automatic update](#automatic-update)
  28. - [Enabling additional modules](#enabling-additional-modules)
  29. - [Running](#running)
  30. - [Getting to know Prelude](#getting-to-know-prelude)
  31. - [Keymap](#keymap)
  32. - [Global](#global)
  33. - [Prelude Mode](#prelude-mode)
  34. - [OSX modifier keys](#osx-modifier-keys)
  35. - [Projectile](#projectile)
  36. - [Helm](#helm)
  37. - [Key-chords](#key-chords)
  38. - [Disabling key-chords](#disabling-key-chords)
  39. - [Automatic package installation](#automatic-package-installation)
  40. - [Color Themes](#color-themes)
  41. - [Personalizing](#personalizing)
  42. - [Disabling whitespace-mode](#disabling-whitespace-mode)
  43. - [Disable flyspell-mode](#disable-flyspell-mode)
  44. - [Caveats & Pitfalls](#caveats--pitfalls)
  45. - [Updating bundled packages](#updating-bundled-packages)
  46. - [Problems with flyspell-mode](#problems-with-flyspell-mode)
  47. - [Ugly colors in the terminal Emacs version](#ugly-colors-in-the-terminal-emacs-version)
  48. - [MELPA error on initial startup](#melpa-error-on-initial-startup)
  49. - [No arrow navigation in editor buffers](#no-arrow-navigation-in-editor-buffers)
  50. - [Customized C-a behavior](#customized-c-a-behavior)
  51. - [Poor ido matching performance on large datasets](#poor-ido-matching-performance-on-large-datasets)
  52. - [Windows compatibility](#windows-compatibility)
  53. - [Known issues](#known-issues)
  54. - [Support](#support)
  55. - [Contributors](#contributors)
  56. - [Bugs & Improvements](#bugs--improvements)
  57. ## Fast Forward
  58. Assuming you're using an Unix-like OS (`*BSD`, `GNU/Linux`, `OS X`, `Solaris`,
  59. etc), you already have Emacs 24 installed, as well as `git` & `curl` you
  60. can skip the whole manual and just type in your favorite shell the
  61. following command:
  62. ```bash
  63. curl -L http://git.io/epre | sh
  64. ```
  65. You can now power up your Emacs, sit back and enjoy Prelude,
  66. forgetting about the rest of this manual.
  67. There are two environment variables you can use to control the
  68. source repository and the installation directory. To change the
  69. installation directory:
  70. ```bash
  71. export PRELUDE_INSTALL_DIR="$HOME/.emacs.d" && curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh
  72. ```
  73. To change the source repository:
  74. ```bash
  75. export PRELUDE_URL="https://github.com/yourname/prelude.git" && curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh
  76. ```
  77. Note that the installer will back up any existing `.emacs` file or
  78. `.emacs.d` since it will unpack Prelude's code in `.emacs.d`. If
  79. you're doing a manual install make sure you don't have a `.emacs` file
  80. or back up your existing `.emacs.d` directory manually.
  81. Don't forget to adjust your `prelude-modules.el` file once the installation is done.
  82. By default most of the modules that ship with Prelude are not loaded.
  83. ## Installing Emacs 24
  84. Obviously to use the Emacs Prelude you have to install Emacs 24
  85. first. Have a look at the [WikEmacs articles on installing Emacs](http://wikemacs.org/index.php/Installing_Emacs).
  86. ## Installation
  87. ### Automated
  88. You can install **Emacs Prelude** via the command line with either `curl` or
  89. `wget`. Naturally `git` is also required.
  90. #### Via Curl
  91. If you're using `curl` type the following command:
  92. ```bash
  93. curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh
  94. ```
  95. #### Via Wget
  96. If you're using `wget` type:
  97. ```bash
  98. wget --no-check-certificate https://github.com/bbatsov/prelude/raw/master/utils/installer.sh -O - | sh
  99. ```
  100. ### Manual
  101. ```bash
  102. git clone git://github.com/bbatsov/prelude.git path/to/local/repo
  103. ln -s path/to/local/repo ~/.emacs.d
  104. cd ~/.emacs.d
  105. ```
  106. If you are using Windows, you should check what Emacs thinks the `~` directory is by running Emacs and typing `C-x d ~/<RET>`, and then adjust the command appropriately.
  107. ## Updating Prelude
  108. ### Manual update
  109. The update procedure is fairly straightforward and consists of 3 steps:
  110. #### Update all bundled packages
  111. Just run <kbd>M-x package-list-packages RET U x</kbd>.
  112. #### Update Prelude's code
  113. ```bash
  114. cd path/to/prelude/installation
  115. git pull
  116. ```
  117. The `path/to/prelude/installation` is usually `~/.emacs.d` (at least
  118. on Unix systems).
  119. #### Restart Prelude
  120. It's generally a good idea to stop Emacs after you do the update. The
  121. next time Prelude starts it will install any new dependencies (if
  122. there are such).
  123. ### Automatic update
  124. Simply run <kbd>M-x prelude-update</kbd> from Emacs itself and restart Emacs afterwards.
  125. ## Enabling additional modules
  126. By default most of the modules that ship with Prelude are not loaded. For more information on the functionality provided by these modules visit the [docs](modules/doc/README.md).
  127. ```lisp
  128. ;;; Uncomment the modules you'd like to use and restart Prelude afterwards
  129. (require 'prelude-c)
  130. ;; (require 'prelude-clojure)
  131. ;; (require 'prelude-coffee)
  132. ;; (require 'prelude-common-lisp)
  133. ;; (require 'prelude-css)
  134. (require 'prelude-emacs-lisp)
  135. (require 'prelude-erc)
  136. ;; (require 'prelude-erlang)
  137. ;; (require 'prelude-haskell)
  138. (require 'prelude-js)
  139. ;; (require 'prelude-latex)
  140. (require 'prelude-lisp)
  141. ;; (require 'prelude-mediawiki)
  142. (require 'prelude-org)
  143. (require 'prelude-perl)
  144. ;; (require 'prelude-python)
  145. ;; (require 'prelude-ruby)
  146. ;; (require 'prelude-scala)
  147. (require 'prelude-scheme)
  148. ;; (require 'prelude-scss)
  149. ;; (require 'prelude-web)
  150. (require 'prelude-xml)
  151. ```
  152. You'll need to adjust your `prelude-modules.el` file once the
  153. installation is done. If you are doing a manual install then you first
  154. need to copy the `prelude-modules.el` available in the sample
  155. directory to the root of `path/to/prelude/installation` and then
  156. adjust that one.
  157. After you've uncommented a module you should either restart Emacs or evaluate the module
  158. `require` expression with <kbd>C-x C-e</kbd>.
  159. ## Running
  160. Nothing fancy here. Just start Emacs as usual. Personally I run Emacs
  161. in daemon mode:
  162. ```bash
  163. emacs --daemon
  164. ```
  165. Afterwards I connect to the server with either a terminal or a GUI
  166. client like this:
  167. ```bash
  168. emacsclient -t
  169. emacsclient -c
  170. ```
  171. You'd probably do well to put a few aliases in your `.zshrc` (or
  172. `.bashrc`):
  173. ```bash
  174. alias e='emacsclient -t'
  175. alias ec='emacsclient -c'
  176. alias vim='emacsclient -t'
  177. alias vi='emacsclient -t'
  178. ```
  179. The last two aliases are helpful if you're used to editing files from
  180. the command line using `vi(m)`.
  181. ## Getting to know Prelude
  182. Certainly the best way to understand how Prelude enhances the default
  183. Emacs experience is to peruse Prelude's source code (which is
  184. obviously written in Emacs Lisp). Understanding the code is not
  185. necessary of course. Prelude includes a `prelude-mode` minor Emacs mode
  186. which collects some of the additional functionality added by
  187. Prelude. It also adds an additional keymap that binds many of those
  188. extensions to keybindings.
  189. ### Keymap
  190. #### Global
  191. Keybinding | Description
  192. -------------------|------------------------------------------------------------
  193. <kbd>C-x \\</kbd> | `align-regexp`
  194. <kbd>C-+</kbd> | Increase font size(`text-scale-increase`).
  195. <kbd>C--</kbd> | Decrease font size(`text-scale-decrease`).
  196. <kbd>C-x O</kbd> | Go back to previous window (the inverse of `other-window` (`C-x o`)).
  197. <kbd>C-^</kbd> | Join two lines into one(`prelude-top-join-line`).
  198. <kbd>C-x p</kbd> | Start `proced` (manage processes from Emacs; works only in Linux).
  199. <kbd>C-x m</kbd> | Start `eshell`.
  200. <kbd>C-x M-m</kbd> | Start your default shell.
  201. <kbd>C-x C-m</kbd> | Alias for `M-x`.
  202. <kbd>M-X</kbd> | Like `M-x` but limited to commands that are relevant to the active major mode.
  203. <kbd>C-h A</kbd> | Run `apropos` (search in all Emacs symbols).
  204. <kbd>C-h C-m</kbd> | Display key bindings of current major mode and descriptions of every binding.
  205. <kbd>M-/</kbd> | Run `hippie-expand` (a replacement for the default `dabbrev-expand`).
  206. <kbd>C-x C-b</kbd> | Open `ibuffer` (a replacement for the default `buffer-list`).
  207. <kbd>F11</kbd> | Make the window full screen.
  208. <kbd>F12</kbd> | Toggle the Emacs menu bar.
  209. <kbd>C-x g</kbd> | Open Magit's status buffer.
  210. <kbd>M-Z</kbd> | Zap up to char.
  211. <kbd>C-c J</kbd> or <kbd>Super-></kbd> | Switch between buffers with [`ace-jump-buffer`](https://github.com/waymondo/ace-jump-buffer)
  212. <kbd>C-=</kbd> | Run `expand-region` (incremental text selection).
  213. <kbd>C-a</kbd> | Run `prelude-move-beginning-of-line`. Read [this](http://emacsredux.com/blog/2013/05/22/smarter-navigation-to-the-beginning-of-a-line/) for details.
  214. #### Prelude Mode
  215. Keybinding | Description
  216. -------------------|------------------------------------------------------------
  217. <kbd>C-c o</kbd> | Open the currently visited file with an external program.
  218. <kbd>C-c i</kbd> | Search for a symbol, only for buffers that contain code
  219. <kbd>C-c g</kbd> | Search in Google for the thing under point (or an interactive query).
  220. <kbd>C-c G</kbd> | Search in GitHub for the thing under point (or an interactive query).
  221. <kbd>C-c y</kbd> | Search in YouTube for the thing under point (or an interactive query).
  222. <kbd>C-c U</kbd> | Search in Duckduckgo for the thing under point (or an interactive query).
  223. <kbd>C-S-RET</kbd> or <kbd>Super-o</kbd> | Insert an empty line above the current line and indent it properly.
  224. <kbd>S-RET</kbd> or <kbd>M-o</kbd> | Insert an empty line and indent it properly (as in most IDEs).
  225. <kbd>C-S-up</kbd> or <kbd>M-S-up</kbd> | Move the current line or region up.
  226. <kbd>C-S-down</kbd> or <kbd>M-S-down</kbd>| Move the current line or region down.
  227. <kbd>C-c n</kbd> | Fix indentation in buffer and strip whitespace.
  228. <kbd>C-c f</kbd> | Open recently visited file.
  229. <kbd>C-M-\\</kbd> | Indent region (if selected) or the entire buffer.
  230. <kbd>C-c u</kbd> | Open a new buffer containing the contents of URL.
  231. <kbd>C-c e</kbd> | Eval a bit of Emacs Lisp code and replace it with its result.
  232. <kbd>C-c s</kbd> | Swap two active windows.
  233. <kbd>C-c D</kbd> | Delete current file and buffer.
  234. <kbd>C-c d</kbd> | Duplicate the current line (or region).
  235. <kbd>C-c M-d</kbd> | Duplicate and comment the current line (or region).
  236. <kbd>C-c r</kbd> | Rename the current buffer and its visiting file if any.
  237. <kbd>C-c t</kbd> | Open a terminal emulator (`ansi-term`).
  238. <kbd>C-c k</kbd> | Kill all open buffers except the one you're currently in.
  239. <kbd>C-c TAB</kbd> | Indent and copy region to clipboard
  240. <kbd>C-c I</kbd> | Open user's init file.
  241. <kbd>C-c S</kbd> | Open shell's init file.
  242. <kbd>C-c . +</kbd> | Increment integer at point. Default is +1.
  243. <kbd>C-c . -</kbd> | Decrement integer at point. Default is -1.
  244. <kbd>C-c . *</kbd> | Multiply integer at point. Default is *2.
  245. <kbd>C-c . /</kbd> | Divide integer at point. Default is /2.
  246. <kbd>C-c . \\</kbd> | Modulo integer at point. Default is modulo 2.
  247. <kbd>C-c . ^</kbd> | Power to the integer at point. Default is ^2.
  248. <kbd>C-c . <</kbd> | Left-shift integer at point. Default is 1 position to the left.
  249. <kbd>C-c . ></kbd> | Right-shift integer at point. Default is 1 position to the right.
  250. <kbd>C-c . #</kbd> | Convert integer at point to specified base. Default is 10.
  251. <kbd>C-c . %</kbd> | Replace integer at point with another specified integer.
  252. <kbd>C-c . '</kbd> | Perform arithmetic operations on integer at point. User specifies the operator.
  253. <kbd>Super-g</kbd> | Toggle between God mode and non-God mode
  254. <kbd>Super-r</kbd> | Recent files
  255. <kbd>Super-j</kbd> | Join lines
  256. <kbd>Super-k</kbd> | Kill whole line
  257. <kbd>Super-m m</kbd> | Magit status
  258. <kbd>Super-m l</kbd> | Magit log
  259. <kbd>Super-m f</kbd> | Magit file log
  260. <kbd>Super-m b</kbd> | Magit blame mode
  261. **Note**: For various arithmetic operations, the prefix `C-c .` only needs to be pressed once for the first operation.
  262. For subsequent operations, only the appropriate operations (i.e. `+`, `-`, `*`, `/`... needs to be pressed).
  263. #### OSX modifier keys
  264. Prelude does not mess by default with the standard mapping of `Command` (to `Super`) and `Option` (to `Meta`).
  265. If you want to swap them add this to your personal config:
  266. ```lisp
  267. (setq mac-command-modifier 'meta)
  268. (setq mac-option-modifier 'super)
  269. ```
  270. You can also temporarily swap them with `C-c w` (`M-x prelude-swap-meta-and-super`).
  271. #### Projectile
  272. Here's a list of functionality provided by [Projectile](https://github.com/bbatsov/projectile):
  273. Keybinding | Description
  274. -------------------|------------------------------------------------------------
  275. <kbd>C-c p f</kbd> | Display a list of all files in the project. With a prefix argument it will clear the cache first.
  276. <kbd>C-c p d</kbd> | Display a list of all directories in the project. With a prefix argument it will clear the cache first.
  277. <kbd>C-c p T</kbd> | Display a list of all test files(specs, features, etc) in the project.
  278. <kbd>C-c p s g</kbd> | Run grep on the files in the project.
  279. <kbd>M-- C-c p s g</kbd> | Run grep on `projectile-grep-default-files` in the project.
  280. <kbd>C-c p b</kbd> | Display a list of all project buffers currently open.
  281. <kbd>C-c p o</kbd> | Runs `multi-occur` on all project buffers currently open.
  282. <kbd>C-c p r</kbd> | Runs interactive query-replace on all files in the projects.
  283. <kbd>C-c p i</kbd> | Invalidates the project cache (if existing).
  284. <kbd>C-c p R</kbd> | Regenerates the projects `TAGS` file.
  285. <kbd>C-c p k</kbd> | Kills all project buffers.
  286. <kbd>C-c p D</kbd> | Opens the root of the project in `dired`.
  287. <kbd>C-c p e</kbd> | Shows a list of recently visited project files.
  288. <kbd>C-c p s a</kbd> | Runs `ack` on the project. Requires the presence of `ack-and-a-half`.
  289. <kbd>C-c p s s</kbd> | Runs `ag` on the project. Requires the presence of `ag.el`.
  290. <kbd>C-c p a</kbd> | Runs `ack` on the project. Requires the presence of `ack-and-a-half`.
  291. <kbd>C-c p c</kbd> | Runs a standard compilation command for your type of project.
  292. <kbd>C-c p P</kbd> | Runs a standard test command for your type of project.
  293. <kbd>C-c p z</kbd> | Adds the currently visited to the cache.
  294. <kbd>C-c p p</kbd> | Display a list of known projects you can switch to.
  295. Prelude adds an extra keymap prefix `S-p` (`S` stands for
  296. `Super`), so you can use `S-p` instead of `C-c p`.
  297. If you ever forget any of Projectile's keybindings just do a:
  298. <kbd>C-c p C-h</kbd>
  299. #### Helm
  300. Helm is setup according to this guide: [A Package in a league of its own: Helm](http://tuhdo.github.io/helm-intro.html).
  301. You can learn Helm usage and key bindings following the guide. <kbd>C-c h</kbd> is Prelude's default prefix key for Helm.
  302. If you don't remember any key binding, append <kbd>C-h</kbd> after <kbd>C-c h</kbd> for a list of key bindings in Helm.
  303. If you love Helm and want to use Helm globally with enhanced `helm-find-files`, `helm-buffer-lists`..., you will have to also add `(require 'prelude-helm-everywhere)`.
  304. When `prelude-helm-everywhere` is activated, Helm enables these global key bindings:
  305. Key binding | Description
  306. -------------------|----------------------------------------------
  307. <kbd>M-x</kbd> | Run [helm-M-x](http://tuhdo.github.io/helm-intro.html#sec-3), an interactive version of <kbd>M-x</kdb>.
  308. <kbd>M-y</kbd> | Run [helm-show-kill-ring](http://tuhdo.github.io/helm-intro.html#sec-4), shows the content of `kill-ring`.
  309. <kbd>C-x b </kbd> | Run [helm-mini](http://tuhdo.github.io/helm-intro.html#sec-5), an interactive version of `C-x b` with more features.
  310. <kbd>C-x C-f</kbd> | Run [helm-find-files](http://tuhdo.github.io/helm-intro.html#sec-6), an interactive version of `find-file` with more features.
  311. <kbd>C-h f </kbd> | Run [helm-apropos](http://tuhdo.github.io/helm-intro.html#sec-13), an interactive version of `apropos-command`.
  312. <kbd>C-h r</kbd> | Run [helm-info-emacs](http://tuhdo.github.io/helm-intro.html#sec-14), an interactive version of `info-emacs-manual`.
  313. <kbd>C-h C-l </kbd>| Run `helm-locate-library` that can search for locations of any file loaded into Emacs.
  314. This key binding is activated in `shell-mode`:
  315. Key Binding | Description
  316. -------------------|----------------------------------------------
  317. <kbd>C-c C-l</kbd> | Run `helm-comint-input-ring` that shows `shell` history using Helm interface.
  318. This key bindings is activated in `eshell-mode`:
  319. Key Binding | Description
  320. -------------------|----------------------------------------------
  321. <kbd>C-c C-l</kbd> | Run `helm-eshell-history` that shows `eshell` history using Helm interface.
  322. If you prefer Ido in everywhere, you should not add `prelude-helm-everywhere`, so you can use Helm along with Ido and Prelude's default commands.
  323. You can always reactivate Helm with `(prelude-global-helm-global-mode-on)`.
  324. #### Key-chords
  325. **Key-chords are available only when the `prelude-key-chord` module has been enabled.**
  326. Keybinding | Description
  327. -------------------|----------------------------------------------
  328. <kbd>jj</kbd> | Jump to the beginning of a word(`ace-jump-word-mode`)
  329. <kbd>jk</kbd> | Jump to a character(`ace-jump-char-mode`)
  330. <kbd>jl</kbd> | Jump to the beginning of a line(`ace-jump-line-mode`)
  331. <kbd>JJ</kbd> | Jump back to previous buffer(`prelude-switch-to-previous-buffer`)
  332. <kbd>uu</kbd> | View edits as a tree(`undo-tree-visualize`)
  333. <kbd>xx</kbd> | Executed extended command(`execute-extended-command`)
  334. <kbd>yy</kbd> | Browse the kill ring(`browse-kill-ring`)
  335. ##### Disabling key-chords
  336. In some cases you may not want to have a key-chord that is defined by prelude,
  337. in which case you can disable the binding in your `personal.el` file by setting
  338. its command to `nil`. For example, to disable the `jj` key-chord add the
  339. following line:
  340. ```lisp
  341. (key-chord-define-global "jj" nil)
  342. ```
  343. If you're an `evil-mode` user you'll probably do well to disable `key-chord-mode` altogether:
  344. ```lisp
  345. (key-chord-mode -1)
  346. ```
  347. #### vim emulation
  348. If you want to use vim inside of emacs enable the `prelude-evil` module which provides
  349. support for `evil-mode`.
  350. ## Automatic package installation
  351. The default Prelude installation comes with a bare minimum of
  352. functionality. It will however install add-ons for various programming
  353. languages and frameworks on demand. For instance - if you try to open
  354. a `.clj` file `clojure-mode`, `cider` and Prelude's enhanced Lisp
  355. configuration will be installed automatically for you.
  356. You can, of course, install anything you wish manually as well.
  357. ### Color Themes
  358. Emacs 24 ships with a new theming facility that effectively renders
  359. the old color-theme package obsolete. Emacs 24 provides a dozen of
  360. built-in themes you can use out-of-the-box by invoking the `M-x
  361. load-theme` command.
  362. [Zenburn](https://github.com/bbatsov/zenburn-emacs) is the default color theme in Prelude, but you can change it
  363. at your discretion. Why Zenburn? I (and lots of hackers around the
  364. world) find it pretty neat for some reason. Personally I find the
  365. default theme pretty tiresome for the eyes, that's why I took that
  366. "controversial" decision to replace it. You can, of course, easily go
  367. back to the default (or select another theme entirely).
  368. To disable Zenburn just put in your personal config the following
  369. line:
  370. ```lisp
  371. (disable-theme 'zenburn)
  372. ```
  373. Or you can use another theme altogether by adding something like:
  374. ```lisp
  375. (load-theme 'solarized-dark t)
  376. ```
  377. **P.S.** Solarized is not available by default - you'll have to
  378. install it from MELPA first (`M-x package-install RET
  379. solarized-theme`).
  380. ### Personalizing
  381. Fork the official Prelude repo and add your own touch to it. You're advised to avoid changing stuff outside of the
  382. personal folder to avoid having to deal with git merge conflicts in the future.
  383. If you'd like to add some auto installation of packages in your
  384. personal config use the following code:
  385. ```lisp
  386. (prelude-require-packages '(some-package some-other-package))
  387. ```
  388. If you require just a single package you can also use:
  389. ```lisp
  390. (prelude-require-package 'some-package)
  391. ```
  392. #### Preloading personal config
  393. Sometimes you might want to load code before Prelude has started loading. Prelude will automatically preload all
  394. Emacs Lisp files in your `personal/preload` directory. Note that at this point you can't using anything from
  395. Prelude, except a few variables like `prelude-dir`, etc (since nothing is yet loaded).
  396. #### Disabling whitespace-mode
  397. Although `whitespace-mode` is awesome some people might find it too
  398. intrusive. You can disable it in your
  399. personal config with the following bit of code:
  400. ```lisp
  401. (setq prelude-whitespace nil)
  402. ```
  403. If you like `whitespace-mode` but prefer it to not automatically
  404. cleanup your file on save, you can disable that behavior by setting
  405. prelude-clean-whitespace-on-save to nil in your config file with:
  406. ```lisp
  407. (setq prelude-clean-whitespace-on-save nil)
  408. ```
  409. The prelude-clean-whitespace-on-save setting can also be set on a
  410. per-file or directory basis by using a file variable or a
  411. .dir-locals.el file.
  412. #### Disable flyspell-mode
  413. If you're not fond of spellchecking on the fly:
  414. ```lisp
  415. (setq prelude-flyspell nil)
  416. ```
  417. ## Caveats & Pitfalls
  418. ### Updating bundled packages
  419. Generally it's a good idea to do a package update before running
  420. updating Prelude, since the latest Prelude code might depend on newer
  421. versions of the bundled packages than you would currently have
  422. installed.
  423. If you're doing manual Prelude updates you should always do a package update first.
  424. `M-x package-list-packages RET U x`
  425. That's not necessary if you're using `M-x prelude-update`, since it
  426. will automatically update the installed packages.
  427. ### Problems with flyspell-mode
  428. Prelude makes heavy use of the flyspell-mode package for spell
  429. checking of various things. The proper operation of flyspell depends
  430. on the presence of the `aspell` program and an `en` dictionary on your
  431. system. You can install `aspell` and the dictionary on OS X with
  432. `homebrew` like this:
  433. ```bash
  434. brew install aspell --with-lang=en
  435. ```
  436. On Linux distros - just use your distro's package manager.
  437. ### Ugly colors in the terminal Emacs version
  438. If your Emacs looks considerably uglier in a terminal (compared to the
  439. GUI version) try adding this to your `.bashrc` or `.zshrc`:
  440. ```bash
  441. export TERM=xterm-256color
  442. ```
  443. Source the `.bashrc` file and start Emacs again.
  444. ### MELPA error on initial startup
  445. If you get some http connection error related to the MELPA repo
  446. just do a manual `M-x package-refresh-contents` and restart Emacs
  447. afterwards.
  448. ### Warnings on arrow navigation in editor buffers
  449. This is not a bug - it's a feature! I firmly believe that the one true
  450. way to use Emacs is by using it the way it was intended to be used (as
  451. far as navigation is concerned at least).
  452. If you'd like to be take this a step further and disable the arrow key navigation
  453. completely put this in your personal config:
  454. ```lisp
  455. (setq guru-warn-only nil)
  456. ```
  457. To disable `guru-mode` completely add the following snippet to your
  458. personal Emacs config:
  459. ```lisp
  460. (setq prelude-guru nil)
  461. ```
  462. ### Customized C-a behavior
  463. Prelude overrides `C-a` to behave as described
  464. [here](http://emacsredux.com/blog/2013/05/22/smarter-navigation-to-the-beginning-of-a-line/). If
  465. you don't like that simply add this to your personal config:
  466. ```lisp
  467. (global-set-key [remap move-beginning-of-line]
  468. 'move-beginning-of-line)
  469. ```
  470. ### Poor ido matching performance on large datasets
  471. Prelude swaps the default `ido` flex matching with the more powerful
  472. [ido-flx](https://github.com/lewang/flx).
  473. The sorting algorithm `flx` uses is more complex, but yields better results.
  474. On slower machines, it may be necessary to lower `flx-ido-threshhold` to
  475. ensure a smooth experience.
  476. ```lisp
  477. (setq flx-ido-threshhold 1000)
  478. ```
  479. You can always disable the improved sorting algorithm all together like this:
  480. ```lisp
  481. (flx-ido-mode -1)
  482. ```
  483. ### Windows compatibility
  484. While everything in Prelude should work fine in Windows, I test it only
  485. with Linux & OSX, so there are Windows related problems from time to
  486. time. This situation will probably improve over time.
  487. ## Known issues
  488. Check out the project's
  489. [issue list](https://github.com/bbatsov/prelude/issues?sort=created&direction=desc&state=open)
  490. a list of unresolved issues. By the way - feel free to fix any of them
  491. and send me a pull request. :-)
  492. ## Support
  493. Support is available via the Prelude Google Group <emacs-prelude@googlegroups.com>.
  494. There's also a Freenode channel you can visit - `#prelude-emacs`.
  495. ## Contributors
  496. Here's a [list](https://github.com/bbatsov/prelude/contributors) of all the people who have contributed to the
  497. development of Emacs Prelude.
  498. ## Bugs & Improvements
  499. Bug reports and suggestions for improvements are always
  500. welcome. GitHub pull requests are even better! :-)
  501. I'm also accepting financial contributions via [gittip](https://www.gittip.com/bbatsov).
  502. [![Support via Gittip](https://rawgithub.com/twolfson/gittip-badge/0.2.0/dist/gittip.png)](https://www.gittip.com/bbatsov)
  503. Cheers,<br/>
  504. [Bozhidar](https://twitter.com/bbatsov)
  505. [badge-license]: https://img.shields.io/badge/license-GPL_3-green.svg