Fixed README.md

This commit is contained in:
larstvei 2014-01-27 14:40:00 +01:00
parent 92ac81466f
commit 57e216e2b8

139
README.md
View File

@ -63,6 +63,7 @@ To avoid doing this each time a change is made we can add a function to
the `after-save-hook` ensuring to always tangle and byte-compile the
`org`-document after changes.
```lisp
(defun init-hook ()
"If the current buffer is 'init.org' the code-blocks are
tangled, and the tangled file is compiled."
@ -72,6 +73,7 @@ the `after-save-hook` ensuring to always tangle and byte-compile the
(byte-compile-file (concat user-emacs-directory "init.el"))))
(add-hook 'after-save-hook 'init-hook)
```
## Package
@ -79,18 +81,23 @@ Managing extensions for Emacs is simplified using `package` which
is built in to Emacs 24 and newer. To load downloaded packages we
need to initialize `package`.
```lisp
(require 'package)
(package-initialize)
```
Packages can be fetched from different mirrors, [melpa](http://melpa.milkbox.net/#/) is the largest
archive and is well maintained.
```lisp
(add-to-list 'package-archives
'("MELPA" . "http://melpa.milkbox.net/packages/") t)
```
We can define a predicate that tells us wither or not the newest version
of a package is installed.
```lisp
(defun newest-package-installed-p (package)
"Return true if the newest available PACKAGE is installed."
(when (package-installed-p package)
@ -100,11 +107,13 @@ of a package is installed.
(and local-pkg-desc newest-pkg-desc
(version-list-= (package-desc-vers (cdr local-pkg-desc))
(package-desc-vers (cdr newest-pkg-desc)))))))
```
Let's write a function to install a package if it is not installed or
upgrades it if a new version has been released. Here our predicate comes
in handy.
```lisp
(defun upgrade-or-install-package (package)
"Unless the newest available version of PACKAGE is installed
PACKAGE is installed and the current version is deleted."
@ -115,6 +124,7 @@ in handy.
(package-version-join
(package-desc-vers (cdr pkg-desc)))))
(package-install package))))
```
The `package-refresh-contents` function downloads archive descriptions,
this is a major bottleneck in this configuration. To avoid this we can
@ -124,10 +134,12 @@ second specifies wither one should update during the initialization. The
third is a path to a file where a time-stamp is stored in order to check
when packages were updated last.
```lisp
(defvar days-between-updates 1)
(defvar do-package-update-on-init t)
(defvar package-last-update-file
(expand-file-name (concat user-emacs-directory ".package-last-update")))
```
The tricky part is figuring out when the last time the Emacs was updated!
Here is a hacky way of doing it, using [time-stamps](http://www.gnu.org/software/emacs/manual/html_node/emacs/Time-Stamps.html). By adding a
@ -135,6 +147,7 @@ time-stamp to the a file, we can determine wither or not to do an
update. After that we must run the `time-stamp`-function to update the
time-stamp.
```lisp
(require 'time-stamp)
;; Open the package-last-update-file
(with-temp-file package-last-update-file
@ -158,11 +171,13 @@ time-stamp.
;; If no such file exists it is created with a time-stamp.
(insert "Time-stamp: <>")
(time-stamp)))
```
Now we can use the function above to make sure packages are installed and
up to date. Here are some packages I find useful (some of these
configurations are also dependent on them).
```lisp
(when (and do-package-update-on-init
(y-or-n-p "Update all packages?"))
(package-refresh-contents)
@ -191,12 +206,14 @@ configurations are also dependent on them).
pretty-lambdada ; the word `lambda' as the Greek letter.
smex)) ; M-x interface with Ido-style fuzzy matching.
(upgrade-or-install-package package)))
```
## Require
Some features are not loaded by default to minimize initialization time,
so they have to be required (or loaded, if you will).
```lisp
(dolist (feature
'(auto-compile ; auto-compile .el files
auto-complete-config ; a configuration for auto-complete-mode
@ -209,6 +226,7 @@ so they have to be required (or loaded, if you will).
recentf ; recently opened files
tex-mode)) ; TeX, LaTeX, and SliTeX mode commands
(require feature))
```
## Sane defaults
@ -216,6 +234,7 @@ These are what *I* consider to be saner defaults.
We can set variables to whatever value we'd like using `setq`.
```lisp
(setq initial-scratch-message nil ; Clean scratch buffer.
inhibit-startup-message t ; No splash screen please.
default-input-method "TeX" ; Use TeX when toggeling input method.
@ -227,33 +246,42 @@ We can set variables to whatever value we'd like using `setq`.
(when (boundp 'mac-pass-command-to-system)
(setq mac-pass-command-to-system nil))
```
Some variables are buffer-local, so changing them using `setq` will only
change them in a single buffer. Using `setq-default` we change the
buffer-local variable's default value.
```lisp
(setq-default fill-column 76 ; Maximum line width.
indent-tabs-mode nil ; Use spaces instead of tabs.
split-width-threshold 100 ; Split verticly by default.
auto-fill-function 'do-auto-fill) ; Auto-fill-mode everywhere.
```
The `load-path` specifies where Emacs should look for `.el`-files (or
Emacs lisp files). I have a directory called `site-lisp` where I keep all
extensions that have been installed manually (these are mostly my own
projects).
```lisp
(let ((default-directory (concat user-emacs-directory "site-lisp/")))
(when (file-exists-p default-directory)
(normal-top-level-add-to-load-path '("."))
(normal-top-level-add-subdirs-to-load-path)))
```
Answering *yes* and *no* to each question from Emacs can be tedious, a
single *y* or *n* will suffice.
```lisp
(fset 'yes-or-no-p 'y-or-n-p)
```
To avoid file system clutter we put all auto saved files in a single
directory.
```lisp
(defvar emacs-autosave-directory
(concat user-emacs-directory "autosaves/")
"This variable dictates where to put auto saves. It is set to a
@ -265,25 +293,34 @@ directory.
`((".*" . ,emacs-autosave-directory))
auto-save-file-name-transforms
`((".*" ,emacs-autosave-directory t)))
```
Set `utf-8` as preferred coding system.
```lisp
(set-language-environment "UTF-8")
```
By default the `narrow-to-region` command is disabled and issues a
warning, because it might confuse new users. I find it useful sometimes,
and don't want to be warned.
```lisp
(put 'narrow-to-region 'disabled nil)
```
Call `auto-complete` default configuration, which enables `auto-complete`
globally.
```lisp
(ac-config-default)
```
Automaticly revert `doc-view`-buffers when the file changes on disk.
```lisp
(add-hook 'doc-view-mode-hook 'auto-revert-mode)
```
## Modes
@ -291,15 +328,18 @@ There are some modes that are enabled by default that I don't find
particularly useful. We create a list of these modes, and disable all of
these.
```lisp
(dolist (mode
'(tool-bar-mode ; No toolbars, more room for text.
scroll-bar-mode ; No scroll bars either.
blink-cursor-mode)) ; The blinking cursor gets old.
(funcall mode 0))
```
Let's apply the same technique for enabling modes that are disabled by
default.
```lisp
(dolist (mode
'(abbrev-mode ; E.g. sopl -> System.out.println.
auto-compile-on-load-mode ; Compile .el files on load ...
@ -309,21 +349,28 @@ default.
recentf-mode ; Recently opened files.
show-paren-mode)) ; Highlight matching parentheses.
(funcall mode 1))
```
This makes `.md`-files open in `markdown-mode`.
```lisp
(add-to-list 'auto-mode-alist '("\\.md\\'" . markdown-mode))
```
## Visual
Change the color-theme to `monokai` (downloaded using `package`).
```lisp
(load-theme 'monokai t)
```
Use the [Inconsolata](http://www.levien.com/type/myfonts/inconsolata.html) font if it's installed on the system.
```lisp
(when (member "Inconsolata" (font-family-list))
(set-face-attribute 'default nil :font "Inconsolata-13"))
```
## Ido
@ -333,37 +380,46 @@ names you can write a part of it and select one from a list of
possibilities. Using `ido-vertical-mode` changes the way possibilities
are displayed, and `flx-ido-mode` enables fuzzy matching.
```lisp
(dolist (mode
'(ido-mode ; Interactivly do.
ido-everywhere ; Use Ido for all buffer/file reading.
ido-vertical-mode ; Makes ido-mode display vertically.
flx-ido-mode)) ; Toggle flx ido mode.
(funcall mode 1))
```
We can set the order of file selections in `ido`. I prioritize source
files along with `org`- and `tex`-files.
```lisp
(setq ido-file-extensions-order
'(".el" ".scm" ".lisp" ".java" ".c" ".h" ".org" ".tex"))
```
Sometimes when using `ido-switch-buffer` the `*Messages*` buffer get in
the way, so we set it to be ignored (it can be accessed using `C-h e`, so
there is really no need for it in the buffer list).
```lisp
(add-to-list 'ido-ignore-buffers "*Messages*")
```
To make `M-x` behave more like `ido-mode` we can use the `smex`
package. It needs to be initialized, and we can replace the binding to
the standard `execute-extended-command` with `smex`.
```lisp
(smex-initialize)
(global-set-key (kbd "M-x") 'smex)
```
## Calendar
Define a function to display week numbers in `calender-mode`. The snippet
is from [EmacsWiki](http://www.emacswiki.org/emacs/CalendarWeekNumbers).
```lisp
(defun calendar-show-week (arg)
"Displaying week number in calendar-mode."
(interactive "P")
@ -379,17 +435,22 @@ is from [EmacsWiki](http://www.emacswiki.org/emacs/CalendarWeekNumbers).
(calendar-absolute-from-gregorian
(list month day year)))))
'font-lock-face 'calendar-iso-week-face))))
```
Evaluate the `calendar-show-week` function.
```lisp
(calendar-show-week t)
```
Set Monday as the first day of the week, and set my location.
```lisp
(setq calendar-week-start-day 1
calendar-latitude 60.0
calendar-longitude 10.7
calendar-location-name "Oslo, Norway")
```
## Mail
@ -398,6 +459,7 @@ computers. Because the mail-setup wont work without these programs
installed we bind `load-mail-setup` to `nil`. If the value is changed to
a `non-nil` value mail is setup.
```lisp
(defvar load-mail-setup nil)
(when load-mail-setup
@ -448,49 +510,62 @@ a `non-nil` value mail is setup.
;; Overwrite the native 'compose-mail' binding to 'show-mu4e'.
(global-set-key (kbd "C-x m") 'mu4e))
```
## Flyspell
Flyspell offers on-the-fly spell checking. We can enable flyspell for all
text-modes with this snippet.
```lisp
(add-hook 'text-mode-hook 'turn-on-flyspell)
```
To use flyspell for programming there is `flyspell-prog-mode`, that only
enables spell checking for comments and strings. We can enable it for all
programming modes using the `prog-mode-hook`. Flyspell interferes with
auto-complete mode, but there is a workaround provided by auto complete.
```lisp
(add-hook 'prog-mode-hook 'flyspell-prog-mode)
(ac-flyspell-workaround)
```
To cycle through dictionary's we can define a variable containing a
cyclic list of installed language packs.
```lisp
(defvar ispell-languages '#1=("english" "norsk" . #1#))
```
Now we only need a small function to change set the language and shift
the list.
```lisp
(defun cycle-languages ()
"Changes the ispell-dictionary to whatever is the next (or cdr) in the
LANGUAGES (cyclic) list."
(interactive)
(ispell-change-dictionary
(car (setq ispell-languages (cdr ispell-languages)))))
```
## Org
I use `org-agenda` for appointments and such.
```lisp
(setq org-agenda-start-on-weekday nil ; Show agenda from today.
org-agenda-files '("~/Dropbox/life.org") ; A list of agenda files.
org-agenda-default-appointment-duration 120) ; 2 hours appointments.
```
When editing org-files with source-blocks, we want the source blocks to
be themed as they would in their native mode.
```lisp
(setq org-src-fontify-natively t)
```
## Interactive functions
@ -499,35 +574,42 @@ be themed as they would in their native mode.
To search recent files useing `ido-mode` we add this snippet from
[EmacsWiki](http://www.emacswiki.org/emacs/CalendarWeekNumbers).
```lisp
(defun recentf-ido-find-file ()
"Find a recent file using Ido."
(interactive)
(let ((f (ido-completing-read "Choose recent file: " recentf-list nil t)))
(when f
(find-file f))))
```
`just-one-space` removes all whitespace around a point - giving it a
negative argument it removes newlines as well. We wrap a interactive
function around it to be able to bind it to a key.
```lisp
(defun remove-whitespace-inbetween ()
"Removes whitespace before and after the point."
(interactive)
(just-one-space -1))
```
This interactive function switches you to a `shell`, and if triggered in
the shell it switches back to the previous buffer.
```lisp
(defun switch-to-shell ()
"Jumps to eshell or back."
(interactive)
(if (string= (buffer-name) "*shell*")
(switch-to-prev-buffer)
(shell)))
```
To duplicate either selected text or a line we define this interactive
function.
```lisp
(defun duplicate-thing ()
"Ethier duplicates the line or the region"
(interactive)
@ -538,9 +620,11 @@ function.
(unless (region-active-p)
(newline))
(insert (buffer-substring start end)))))
```
To tidy up a buffer we define this function borrowed from [simenheg](https://github.com/simenheg).
```lisp
(defun tidy ()
"Ident, untabify and unwhitespacify current buffer, or region if active."
(interactive)
@ -549,47 +633,62 @@ To tidy up a buffer we define this function borrowed from [simenheg](https://git
(indent-region beg end)
(whitespace-cleanup)
(untabify beg (if (< end (point-max)) end (point-max)))))
```
## Key bindings
Bindings for [expand-region](https://github.com/magnars/expand-region.el).
```lisp
(global-set-key (kbd "C-'") 'er/expand-region)
(global-set-key (kbd "C-;") 'er/contract-region)
```
Bindings for [multiple-cursors](https://github.com/magnars/multiple-cursors.el).
```lisp
(global-set-key (kbd "C-c e") 'mc/edit-lines)
(global-set-key (kbd "C-c a") 'mc/mark-all-like-this)
(global-set-key (kbd "C-c n") 'mc/mark-next-like-this)
```
Bindings for [Magit](http://magit.github.io).
```lisp
(global-set-key (kbd "C-c m") 'magit-status)
```
Bindings for [ace-jump-mode](https://github.com/winterTTr/ace-jump-mode).
```lisp
(global-set-key (kbd "C-c SPC") 'ace-jump-mode)
```
Bindings for `move-text`.
```lisp
(global-set-key (kbd "<M-S-up>") 'move-text-up)
(global-set-key (kbd "<M-S-down>") 'move-text-down)
```
Bind some native Emacs functions.
```lisp
(global-set-key (kbd "C-c s") 'ispell-word)
(global-set-key (kbd "C-c t") 'org-agenda-list)
(global-set-key (kbd "C-x k") 'kill-this-buffer)
(global-set-key (kbd "C-x C-r") 'recentf-ido-find-file)
```
Bind the functions defined above.
```lisp
(global-set-key (kbd "C-c l") 'cycle-languages)
(global-set-key (kbd "C-c j") 'remove-whitespace-inbetween)
(global-set-key (kbd "C-x t") 'switch-to-shell)
(global-set-key (kbd "C-c d") 'duplicate-thing)
(global-set-key (kbd "<C-tab>") 'tidy)
```
## Advice
@ -597,6 +696,7 @@ An advice can be given to a function to make it behave differently. This
advice makes `eval-last-sexp` (bound to `C-x C-e`) replace the sexp with
the value.
```lisp
(defadvice eval-last-sexp (around replace-sexp (arg) activate)
"Replace sexp when called with a prefix argument."
(if arg
@ -606,20 +706,25 @@ the value.
(backward-kill-sexp)
(forward-sexp))
ad-do-it))
```
`Flyspell` signals an error if there is no spell-checking tool is
installed. We can advice `turn-on=flyspell` and `flyspell-prog-mode` to
only try to enable `flyspell` if a spell-checking tool is avalible.
```lisp
(defadvice turn-on-flyspell (around check nil activate)
"Turns on flyspell only if a spell-checking tool is installed."
(when (executable-find ispell-program-name)
ad-do-it))
```
```lisp
(defadvice flyspell-prog-mode (around check nil activate)
"Turns on flyspell only if a spell-checking tool is installed."
(when (executable-find ispell-program-name)
ad-do-it))
```
# Language mode specific
@ -630,25 +735,31 @@ only try to enable `flyspell` if a spell-checking tool is avalible.
can add some extra lisp-modes. We run the `pretty-lambda-for-modes`
function to activate `pretty-lambda-mode` in lisp modes.
```lisp
(dolist (mode '(slime-repl-mode geiser-repl-mode))
(add-to-list 'pretty-lambda-auto-modes mode))
(pretty-lambda-for-modes)
```
I use `Paredit` when editing lisp code, we enable this for all lisp-modes
in the `pretty-lambda-auto-modes` list.
```lisp
(dolist (mode pretty-lambda-auto-modes)
;; add paredit-mode to all mode-hooks
(add-hook (intern (concat (symbol-name mode) "-hook")) 'paredit-mode))
```
### Emacs Lisp
In `emacs-lisp-mode` we can enable `eldoc-mode` to display information
about a function or a variable in the echo area.
```lisp
(add-hook 'emacs-lisp-mode-hook 'turn-on-eldoc-mode)
(add-hook 'lisp-interaction-mode-hook 'turn-on-eldoc-mode)
```
### Common lisp
@ -658,21 +769,27 @@ Common Lisp developer. [Quicklisp](http://www.quicklisp.org/beta/) is a library
and you can install Slime following the instructions from the site along
with this snippet.
```lisp
(when (file-exists-p "~/quicklisp/slime-helper.elc")
(load (expand-file-name "~/quicklisp/slime-helper.elc")))
```
We can specify what Common Lisp program Slime should use (I use SBCL).
```lisp
(setq inferior-lisp-program "sbcl")
```
To improve auto completion for Common Lisp editing we can use `ac-slime`
which uses slime completions as a source.
```lisp
(add-hook 'slime-mode-hook 'set-up-slime-ac)
(add-hook 'slime-repl-mode-hook 'set-up-slime-ac)
(eval-after-load "auto-complete"
'(add-to-list 'ac-modes 'slime-repl-mode))
```
### Scheme
@ -680,11 +797,13 @@ which uses slime completions as a source.
works pretty much out of the box, we only need to add auto completion,
and specify which scheme-interpreter we prefer.
```lisp
(add-hook 'geiser-mode-hook 'ac-geiser-setup)
(add-hook 'geiser-repl-mode-hook 'ac-geiser-setup)
(eval-after-load "auto-complete"
'(add-to-list 'ac-modes 'geiser-repl-mode))
(setq geiser-active-implementations '(racket))
```
## Java and C
@ -692,27 +811,33 @@ The `c-mode-common-hook` is a general hook that work on all C-like
languages (C, C++, Java, etc&#x2026;). I like being able to quickly compile
using `C-c C-c` (instead of `M-x compile`), a habit from `latex-mode`.
```lisp
(defun c-setup ()
(local-set-key (kbd "C-c C-c") 'compile))
(add-hook 'c-mode-common-hook 'c-setup)
```
Some statements in Java appear often, and become tedious to write
out. We can use abbrevs to speed this up.
```lisp
(define-abbrev-table 'java-mode-abbrev-table
'(("psv" "public static void main(String[] args) {" nil 0)
("sopl" "System.out.println" nil 0)
("sop" "System.out.printf" nil 0)))
```
To be able to use the abbrev table defined above, `abbrev-mode` must be
activated.
```lisp
(defun java-setup ()
(abbrev-mode t)
(setq-local compile-command (concat "javac " (buffer-name))))
(add-hook 'java-mode-hook 'java-setup)
```
## Assembler
@ -720,24 +845,30 @@ When writing assembler code I use `#` for comments. By defining
`comment-start` we can add comments using `M-;` like in other programming
modes. Also in assembler should one be able to compile using `C-c C-c`.
```lisp
(defun asm-setup ()
(setq comment-start "#")
(local-set-key (kbd "C-c C-c") 'compile))
(add-hook 'asm-mode-hook 'asm-setup)
```
## LaTeX
`.tex`-files should be associated with `latex-mode` instead of
`tex-mode`.
```lisp
(add-to-list 'auto-mode-alist '("\\.tex\\'" . latex-mode))
```
I like using the [Minted](https://code.google.com/p/minted/) package for source blocks in LaTeX. To make org
use this we add the following snippet.
```lisp
(add-to-list 'org-latex-packages-alist '("" "minted"))
(setq org-latex-listings 'minted)
```
Because [Minted](https://code.google.com/p/minted/) uses [Pygments](http://pygments.org) (an external process), we must add the
`-shell-escape` option to the `org-latex-pdf-process` commands. The
@ -745,6 +876,7 @@ Because [Minted](https://code.google.com/p/minted/) uses [Pygments](http://pygme
Tex- and LaTeX-mode, we can add the flag with a rather dirty statement
(if anyone finds a nicer way to do this, please let me know).
```lisp
(setq org-latex-pdf-process
(mapcar
(lambda (str)
@ -753,6 +885,7 @@ Tex- and LaTeX-mode, we can add the flag with a rather dirty statement
org-latex-pdf-process))
(setcar (cdr (cddaar tex-compile-commands)) " -shell-escape ")
```
## Python
@ -760,12 +893,14 @@ Tex- and LaTeX-mode, we can add the flag with a rather dirty statement
dependent on some python programs as well, so make sure you follow the
instructions from the site.
```lisp
(setq jedi:server-command
(cons "python3" (cdr jedi:server-command))
python-shell-interpreter "python3")
(add-hook 'python-mode-hook 'jedi:setup)
(setq jedi:complete-on-dot t)
(add-hook 'python-mode-hook 'jedi:ac-setup)
```
## Haskell
@ -773,12 +908,16 @@ instructions from the site.
the echo area. Haskell has several indentation modes - I prefer using
`haskell-indent`.
```lisp
(add-hook 'haskell-mode-hook 'turn-on-haskell-doc-mode)
(add-hook 'haskell-mode-hook 'turn-on-haskell-indent)
```
## Matlab
Matlab is very similar to Octave, which is supported by Emacs. We just
need to let `.m`-files be associated with `octave-mode`.
```lisp
(add-to-list 'matlab-shell-command-switches "-nosplash")
```