Emacs

Emacs 帮助文档相关快捷键如表 1, 2, 3, 4 所示。

说明：要设置变量的值，执行 M-x set-variable 即可。

说明：执行 M-x locate refcard 可查找 emacs 自带的 refcard。

Emacs 文件基本操作相关快捷键如表 5 所示。

Emacs 移动光标相关快捷键如表 6 所示。

Emacs 删除操作相关快捷键如表 7, 8 所示。

emacs 正则表达式中的元字符如下：

  .        any character (but newline)
  *        previous character or group, repeated 0 or more time
  +        previous character or group, repeated 1 or more time
  ?        previous character or group, repeated 0 or 1 time
  ^        start of line
  $        end of line
  [...]    any character between brackets
  [^..]    any character not in the brackets
  [a-z]    any character between a and z
  \        prevents interpretation of following special char
  \|       or
  \w       word constituent
  \b       word boundary
  \sc      character with c syntax (e.g. \s- for whitespace char)
  \( \)    start\end of group
  \< \>    start\end of word
  \_< \_>  start\end of symbol
  \` \'    start\end of buffer\string
  \1       string matched by the first group
  \n       string matched by the nth group
  \{3\}    previous character or group, repeated 3 times
  \{3,\}   previous character or group, repeated 3 or more times
  \{3,6\}  previous character or group, repeated 3 to 6 times
  \=       match succeeds if it is located at point

实例 1: 查找 6 个连续数字
emacs 中的正则表达式，不支持 \d 表示数字，要查询数字请用 [0-9] 。

Esc C-s [0-9]\{6\}

实例 2: 查找 A 和 B 之间有一个或多个空格
emacs 中，空格对应的正则为 \s- ，注意 \s 后还有个连字符。

Esc C-s A\s-+B

参考：http://www.emacswiki.org/emacs/RegularExpression

Emacs 中转换大小写相关快捷键如表 11 所示。

参考：GNU Emacs Manual, 22.6 Case Conversion Commands

The maximum line width for filling is specified by the buffer-local variable fill-column. The default value is 70. The easiest way to set fill-column in the current buffer is to use the command C-x f (set-fill-column).

默认 fill-column 太窄，要设为 80，可把下面这行加入~/.emacs.d/init.el 中：

(setq-default fill-column 80)

要对一个 region 限制行宽，可以执行下面命令：

M-x fill-region

要自动限制行宽，可以打开 auto-fill-mode。

M-x auto-fill-mode

参考：http://www.gnu.org/software/emacs/manual/html_node/emacs/Filling.html

Emacs 中 undo 和 redo 相关快捷键如表 12 所示。

emacs 中没有 redo，要想实现 redo，可以在 undo 前执行下 C-g 。

Emacs 中交换前后文本相关快捷键如表 13 所示。

Emacs 中多窗口操作相关快捷键如表 14 所示。

Emacs 中键盘宏相关快捷键如表 15 所示。

注：这种方法记录的只是一个临时的，没有名字的宏，仅当前 session 有效。

Emacs 中使用 registers 的相关快捷键如表 16 所示。

注：表中的字母 R 为 register 名字，可以修改为其它任意单个字母（大小写敏感）或数字。

查看 register 内容（以 register R 为例）：

M-x view-register RET R

注：好像无法一次查看所有 registers 的内容。

Emacs 中 bookmarks 相关快捷键如表 17 所示。

Emacs 中 bookmarks 和 registers 差不多，也可以保存光标的位置信息，但 registers 不是持久的，而 bookmarks 是持久的，关闭 emacs session 再启动 Emacs 时，bookmarks 仍然存在。

首先选择一个矩形：用 C-@ 设一个 mark，移动光标到另一点（注意，这不会只高亮一个矩阵块）。
然后用表 18 所示命令（都以 C-x r 开头）来进行矩形操作。

参考：http://www.gnu.org/software/emacs/manual/html_node/emacs/Rectangles.html#Rectangles

Emacs 中版本控制相关快捷键如表 19 所示。

小技巧：当用 C-x v = 在“*vc-diff*”窗口中显示所做的改动后，可以用 C-c C-a, 或 M-x diff-apply-hunk 取消/应用当前光标处的部分改动。

Artist mode, toggled by M-x artist-mode, lets you draw lines, squares, rectangles and poly-lines, ellipses, and circles with your mouse and/or keyboard. It is extremely useful when inserting text diagrams or figures in your source comments.

用 artist-mode 在 emacs 中可轻松画出下面图例：

    +---------+
    |         |                        +--------------+
    |   NFS   |--+                     |              |
    |         |  |                 +-->|   CacheFS    |
    +---------+  |   +----------+  |   |  /dev/hda5   |
                 |   |          |  |   +--------------+
    +---------+  +-->|          |  |
    |         |      |          |--+
    |   AFS   |----->| FS-Cache |
    |         |      |          |--+
    +---------+  +-->|          |  |
                 |   |          |  |   +--------------+
    +---------+  |   +----------+  |   |              |
    |         |  |                 +-->|  CacheFiles  |
    |  ISOFS  |--+                     |  /var/cache  |
    |         |                        +--------------+
    +---------+

Reference:
http://www.cinsk.org/emacs/emacs-artist.html
http://unix.stackexchange.com/questions/126630/creating-diagrams-in-ascii

By default, Emacs displays text on graphical displays using a 10-point monospace font. There are several different ways to specify a different font:
(1) Click on 'Set Default Font' in the 'Options' menu. This makes the selected font the default on all existing graphical frames. To save this for future sessions, click on 'Save Options' in the 'Options' menu.
(2) Add a line to your init file, modifying the variable default-frame-alist to specify the font parameter, like this:

          (add-to-list 'default-frame-alist
                       '(font . "DejaVu Sans Mono-10"))

This makes the font the default on all graphical frames created after restarting Emacs with that init file.
(3) Add an 'emacs.font' X resource setting to your X resource file, like this:
emacs.font: DejaVu Sans Mono-12
You must restart X, or use the xrdb command, for the X resources file to take effect.
(4) If you are running Emacs on the GNOME desktop, you can tell Emacs to use the default system font by setting the variablefont-use-system-font to t(the default isnil). For this to work, Emacs must have been compiled with Gconf support.
(5) Use the command line option -fn (or --font).

上面介绍了 5 种方法，前两种比较简单。

参考：http://www.gnu.org/software/emacs/manual/html_node/emacs/Fonts.html#Fonts

M-x ispell-region 对选定区域进行检查
M-x ispell-buffer 对整个当前 buffer 进行检查
M-x ispell-message 写邮件时对邮件进行拼写检查，但不包括引用的内容

M-x flyspell-mode
Enable Flyspell mode, which highlights all misspelled words.

M-$
Check and correct spelling of the word at point (ispell-word).

M-TAB
Complete the word before point based on the spelling dictionary(ispell-complete-word).

M-x ispell-minor-mode
仅在输入文本时，提示单词是否正确。

参考：
GNU Emacs Manual Version 24.1, 13.4 Checking and Correcting Spelling

执行 M-x calendar 可启动日历。

在日历中移动的相关快捷键如表 20 所示。

查看农历的相关快捷键如表 21 所示。

其它命令参考表 22 。

设置提醒：

M-x appt-active

process-environment

该变量保存着进程的所有环境变量。

initial-environment

该变量保存着从父进程继承过来的环境变量。

注：
M-x getenv，可查看 process-environment 中保存的环境变量
M-x setenv，设置环境变量，会保存在 process-environment 中。

M-x ansi-term
M-x term
M-x shell
M-x eshell

注：

• 请使用 M-x term 或 M-x ansi-term，它们功能更强大（如果使用的是 M-x shell，可能连 man ls 等命令都无法使用！）
  
• 进入到 ansi-term 后，想直接执行命令时，按 M-x 无效了，应该按 C-x M-x
  

gomoku

五子棋

tetris

俄罗斯方块

5X5

游戏的目的是用#号填满整个方框。按下空格后，以光标为中心的十字会在空格和#号间变换

首先选择要操作的内容，再用表 23 所示命令对其进行排序。

表 24 是在 Emacs 中插入特殊字符的例子。

直接插入 Unicode 对应字符：
输入 C-x 8 后紧接着按回车键（对应函数 insert-char ）后可以直接输入 Unicode 对应字符。

The commands tabify and untabify do just that.

参考：http://www.gnu.org/software/emacs/manual/html_node/emacs/Just-Spaces.html

常用的 emacs 命令行参数：

-nw

不启动 GUI，以终端形式启动。

-q

不加载启动文件。

-Q

Similar to -q --no-site-file --no-splash. Also, avoid processing X resources.

-l file

指定启动时要加载的文件。

-u user

Load user's init file.

--debug-init

This is useful for debugging problems in the init file.

如果修改了 emacs 启动文件 init.el，如何不重启 emacs 的情况下使更改生效？有下面几种方法：

• C-x C-e 执行光标前面的一条语句（如果改动比较少的话很方便）。
  
• 选择改动的 region, M-x eval-region
  
• M-x load-file ~/.emacs.d/init.el
  
• M-x eval-buffer
  

首先要安装 ibus 的 emacs 插件(Ubuntu 中可以这样安装 sudo apt-get install ibus-el)。

在启动 emacs 前，先设置 LC_CTYPE=zh_CN.UTF-8 即可，emacs 已经很智能了，它会根据 LC_CTYPE 来取消“Ctrl + Space”的内置绑定。
如果还有问题，可以在/etc/default/locale 中设置 LC_CTYPE=zh_CN.UTF-8

有时 Emacs 遇到错误只会打印简单的错误信息，要想此时进入调试器，可以通过 M-x toggle-debug-on-error 设置。

参考：http://emacs.stackexchange.com/questions/7698/how-to-make-org-export-give-more-messages-when-it-fails

在 Emacs 中使用 Ctrl 的频率非常高，把 Caps Lock 键改为 Ctrl 键可以提高使用 Emacs 的舒适度。

参考：https://www.emacswiki.org/emacs/MovingTheCtrlKey

emacs 在打开文件时可以自动地设置 Major Mode，它的规则是什么呢？

有几种方式（描述顺序不代表其优先级，详细优先级可以查看 emacs manual）：
1.根据文件名自动设置
如打开.c 结尾的文件，就进入 C mode。文件名和 major mode 的对应关系保存在变量 auto-mode-alist 中。

2.根据#!后的解释器设置
当文件的内容以“#!”开头时，这时 Emacs 使用文件中指定的解释器的名字来选择 major mode，解释器和 major mode 的对应关系保存在变量 interpreter-mode-alist 中。
2.1 根据文件开头内容判断
把判断规则写入到 magic-mode-alist 中，如：

(add-to-list 'magic-mode-alist '("<!DOCTYPE html .+DTD XHTML .+>" . nxml-mode) )

2.2 根据定制函数返回值判断
magic-mode-alist 还有一种用法，如：

(add-to-list 'magic-mode-alist '(MATCH-FUNCTION . nxml-mode) )

只要 MATCH-FUNCTION 返回 non-nil 就会设置为 nxml-mode。
显然，这种方法的可定制性更强。

3.根据 File-local variables 设置
什么是 File-local variables？就是把变量写在文件中，Emacs 打开该文件时自动加载其中的变量。当然 File-local variables 要符合一定的规则，以使 emacs 正确识别其中的变量。
File-local variables 有两种形式：
3.1 使用-*-标记
应该成对出现。只能出现在文件第一行（如果第一行以#!开头，可以出现在第二行）。如：

/*  -*- mode:lisp; tab-width: 4; indent-tabs-mode: t; -*-  */

3.2 使用 Local Variables:和 End:标记
Local Variables:和 End:必须成对出现，可以在文件的开头或结尾位置。如：

;; Local Variables: ;;
;; mode:lisp ;;
;; tab-width:4 ;;
;; End: ;;

前缀;;和后缀;;的要求比较宽松，用/*和*/也行，都用##也行。

注：File-local variables 这种办法很强大，因为它仅仅可以定义 mode，还可以设置变量或运行函数等其它事件！但是不太安全！

参考：
Emacs Manual For Emacs 24.1, 20.3 Choosing File Modes.
Emacs Lisp Reference Manual For Emacs 24.1, 23.2.2 How Emacs Chooses a Major Mode.

Dired makes an Emacs buffer containing a listing of a directory, and optionally some of its subdirectories as well. You can use the normal Emacs commands to move around in this buffer, and special Dired commands to operate on the listed files.

参考：
http://www.gnu.org/software/emacs/manual/html_node/emacs/Dired.html
http://www.gnu.org/software/emacs/manual/html_node/dired-x/index.html
http://www.emacswiki.org/DiredExtra

如果新建一个.pl 文件，就自动在文件最前面输入“#!/usr/bin/env perl”等内容该多好啊。 auto-insert-mode 就是为这个功能而设计的。

(require 'autoinsert)
(auto-insert-mode +1)         ; enable auto-insert-mode
(setq auto-insert-query nil)  ; No prompt before insertion

(eval-after-load 'autoinsert
  '(define-auto-insert '("\\.pl\\'" . "Perl skeleton")
     '(nil
       "#!/usr/bin/env perl" \n
       \n
       "use strict;" \n
       "use warnings;" \n \n
       _ \n)))

模板语法基于 Skeleton Mode，比如 _ 表示光标位置等，详情可参考：Emacs Skeleton Language

打开 patch 文件，会自动进入 diff 模式。下面 diff 模式中是常见功能对应的快捷键。

M-o             diff-goto-source

M-n             diff-hunk-next
M-p             diff-hunk-prev

M-N             diff-file-next
M-P             diff-file-prev
M-{             diff-file-prev
M-}             diff-file-next

Ediff provides a convenient way for simultaneous browsing through the differences between a pair (or a triple) of files or buffers (which are called 'variants' for our purposes).

参考：http://www.gnu.org/software/emacs/manual/html_node/ediff/index.html
ediff 比 KDiff3,Diffuse,Vimdiff Meld 强在哪？见图：http://jixiuf.github.io/emacs/ediff.html

CEDET stands for “Collection of Emacs Development Environment Tools”.
CEDET 它包含很多子工具。

M-x cedet-version

会显示类似下面的结果：

CEDET Version:	2.0
  			Requested	File		Loaded
  Package		Version		Version		Version
  ----------------------------------------------------------
  cedet:		2.0		nil		ok
  eieio:		1.4		nil		ok
  semantic:		2.2		nil		ok
  srecode:		1.2		nil		Not Loaded
  ede:			1.2		nil		Not Loaded
  speedbar:		1.0.4		nil		1.0
  cogre:		1.2		nil		Not Loaded
  cedet-contrib:	1.2		nil		Not Loaded

ecb 不是 emacs 内置的，Ubuntu 中可以这样安装：sudo apt-get install ecb

参考：
http://www.xemacs.org/Documentation/packages/html/ecb.html
http://ecb.sourceforge.net/docs/index.html

JDEE stands for Java Development Environment for Emacs.

参考：
http://www.emacswiki.org/JavaDevelopmentEnvironment
http://blog.csdn.net/csfreebird/article/details/19033939
http://blog.csdn.net/csfreebird/article/details/7028174

安装步骤：
测试环境 Ubuntu 14.04 + Emacs 24.3
第一步，从http://sourceforge.net/projects/jdee/files/ 下载 jdee 最新版本文件，如 jdee-bin-2.4.1.tar.bz2
第二步，解压到~/.emacs.d
第三步，添加下面两行到~/.emacs.d/init.el 中

(add-to-list 'load-path "~/.emacs.d/jdee-2.4.1/lisp")
(load "jde")

重启 Emacs，打开 java 文件，可发现菜单栏多了几个 java 相关的菜单。

什么是 Eclim?
Eclim provides the ability to access Eclipse code editing features (code completion, searching, code validation, and many more) via the command line or a local network connection, allowing those features to be integrated with your favorite editor. Eclim provides an integration with Vim, but third party clients have been created to add eclim support to other editors as well (emacs, sublime text 2, textmate).

说明：Eclim 能把 eclipse 的功能集成到 vim 中，通过第三方插件如 Emacs-eclim 也能把 eclispe 的功能集成到 emacs 中。

什么是 Emacs-eclim?
通过 Emacs-eclim 能使 Emacs 使用 eclim 的功能，而通过 eclim 可以使用 eclipse 的功能。
功能介绍可参考：http://www.skybert.net/emacs/java/

Emacs-eclim 非常的强大，代码自动补全，实时语法检查，重构等 eclispe 的功能都不在话下。
唯一的缺点是依赖太重了！ Emacs-eclim 依赖于 eclim，而 eclim 依赖于 eclipse。

安装 eclim
http://eclim.org/install.html
安装配置 Emacs-eclim
https://github.com/senny/emacs-eclim

SLIME stands for The Superior Lisp Interaction Mode for Emacs.
SLIME is a Emacs mode for Common Lisp development. Inspired by existing systems such Emacs Lisp and ILISP, we are working to create an environment for hacking Common Lisp in.

Reference:
SLIME homepage: https://common-lisp.net/project/slime/
SLIME User Manual: https://common-lisp.net/project/slime/doc/html/

参考：
Perl Debug (调试): http://jianlee.ylinux.org/Computer/Perl/perl-debug.html
Beginning Perl Programing with Emacs: http://cpansearch.perl.org/src/YEWENBIN/Emacs-PDE-0.2.16/lisp/doc/QuickStartEn.html

直接用 M-x gdb 启动 gdb（不要用 M-! gdb 的方式启动 gdb）。

M-x gdb-many-windows
可以打开很多窗口(默认 6 个)来辅助调试，这个命令只有在启动 gdb 后才能使用。

M-;

Insert or realign comment on current line; if the region is active, comment or uncomment the region instead (comment-dwim).

C-u M-;

Kill comment on current line (comment-kill).

C-x ;

Set comment column (comment-set-column).

参考：http://www.gnu.org/software/emacs/manual/html_node/emacs/Comment-Commands.html#Comment-Commands

etags

参考：
http://www.gnu.org/software/emacs/manual/html_node/emacs/Tags.html#Tags

生成 tag 文件
如：对当前文件夹的 perl 文件生成 tag

$ find . -name "*.pl" -o -name "*.pm" |etags -

常用操作
M-. tag RET
转到 tag 的定义处（如果不指定 tag，就默认为光标处的 tag）。

M-*
回到上次运行 M-.时的位置。

C-x 4 . tag RET
转到 tag 的定义处，但在新窗口中显示。

C-u M-.
查找下一个 tag 的位置。

C-u - M-.
回到上一个 tag 的位置。

C-M-. pattern RET
Find a tag whose name matches pattern (find-tag-regexp).

C-u C-M-.
Find the next tag whose name matches the last pattern used.

etags 缺点
etags 生成的 TAGS 文件中仅保存了函数的定义，所以无法利用 etags 找到一个函数的所有引用。
下面命令可以实现这个功能：
M-x rgrep
默认把光标处的单词作为查找目标。（搜索内容时，支持一些预定义的别名，比如 ch 表示所有的 c++代码文件，hh 表示所有的 c++头文件等等）
M-x lgrep
仅在本层目录进行搜索，不去子目录中搜索，l是指 local 的意思。

Imenu is a feature that lets users select a definition or section in the buffer, from a menu which lists all of them, to go directly to that location in the buffer.

参考：
http://www.gnu.org/software/emacs/manual/html_node/elisp/Imenu.html
http://emacswiki.org/emacs/ImenuMode

用 imenu 比用 etags 更好的地方——不用生成 TAGS 文件。

M-x imenu
提示输入一个名称（按 table 键会列出所有合法名称），emacs 将跳转到这个名称的定义处。

M-x imenu-add-to-menubar
运行命令后，会提示输入一个名称，确定后 emacs 会生成一个菜单，事先定义好的文件的结构会列在这个菜单下。

Flycheck is a modern on-the-fly syntax checking extension, and a modern alternative to Flymake.
Flycheck-mode 不是 emacs 内置的，要手动安装。

参考：http://www.emacswiki.org/emacs/Flycheck

Emacs 中 cscope 相关的常用快捷键如表 28 所示。

The advice feature lets you add to the existing definition of a function, by advising the function. This is a cleaner method for a library to customize functions defined within Emacs—cleaner than redefining the whole function.

一句话总结：advice 可以改变现有函数的行为，而不必重新定义它。

变量 features 中保存着当前已经加载的 feature（系统中可能存在能加载但没有加载的 feature）。

参考：http://ergoemacs.org/emacs/elisp_library_system.html

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;; Check if a function is defined
(fboundp 'info)                         ; t
(fboundp 'setq)                         ; t

(fboundp 'xyz)                          ; nil

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;; Check if a variable is defined
(boundp 'auto-mode-alist)               ; t
(boundp 'default-input-method)          ; t
(boundp 'nil)                           ; t

(boundp 'xyz)                           ; nil

;; The fboundp actually check a symbol's function cell.
;; Similarly, the boundp checks a symbol's value cell.

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;; Check if a "feature" (package) has been loaded
(featurep 'expand-region)

Reference: http://ergoemacs.org/emacs/elisp_check_defined.html

Here's a example of how to add your own menu. Suppose you want a menu named "MyMenu" that comes after the "Tools" menu. Suppose your menu will have 2 menu items: "Next Line" and "Previous Line", each should call the emacs command next-line and previous-line. Here's the elisp code to do it:

;; Creating a new menu pane in the menu bar to the right of "Tools" menu
(define-key-after
  global-map
  [menu-bar mymenu]
  (cons "MyMenu" (make-sparse-keymap "hoot hoot"))
  'tools )

;; Creating a menu item, under the menu by the id “[menu-bar mymenu]”
(define-key
  global-map
  [menu-bar mymenu nl]
  '("Next Line" . next-line))

;; creating another menu item
(define-key
  global-map
  [menu-bar mymenu pl]
  '("Previous Line" . previous-line))

;; code to remove the whole menu panel
;; (global-unset-key [menu-bar mymenu])

参考：
http://ergoemacs.org/emacs/elisp_menu.html
http://www.gnu.org/software/emacs/manual/html_node/elisp/Keymaps.html

setq 和 set 有什么区别？下面两个设置等价：

(set 'some-variable t)
(setq some-variable t)   ; same as above

setq 和 setq-default 有什么区别？
Some variables in Emacs are “buffer-local”, meaning that each buffer is allowed to have a separate value for that variable that overrides the global default. tab-width is a good example of a buffer-local variable.
If a variable is buffer-local, then setq sets its local value in the current buffer and setq-default sets the global default value.
If a variable is not buffer-local, then setq and setq-default do the same thing.

Reference:
http://stackoverflow.com/questions/18172728/the-difference-between-setq-and-setq-default-in-emacs-lisp

对于简短的 elisp 代码可以直接在 minibuffer 中执行。
如生成 1 到 20 的数字序列：

M-: (dotimes (i 20) (insert (format "%2d\n" (1+ i))))

参考：http://stackoverflow.com/questions/1509688/emacs-macro-to-generate-a-sequence

参考：
An Emacs language mode creation tutorial: http://emacswiki.org/emacs/ModeTutorial
How to Write a Emacs Major Mode for Syntax Coloring: http://ergoemacs.org/emacs/elisp_syntax_coloring.html

Emacs 中，可以通过菜单中的[Options] -> [Customize Emacs]来方便定制 Emacs，可定制的项非常多，它们通过 groups 来组织。
大部分 Emacs package 都有自己的 main customization group，在 main customization group 可能有很多 subgroups。

参考：
http://www.gnu.org/software/emacs/manual/html_node/emacs/Easy-Customization.html
http://www.gnu.org/software/emacs/manual/html_node/elisp/Customization.html