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.

716 lines
27 KiB

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