WikEmacs - User contributions [en]

User:Francesco

2012-12-10T10:31:03Z

Francesco: Added list of contributions to packages

I use Emacs on a daily basis, mostly for
* software development (C++, Python)
* document authoring (LaTeX)
* organizing my work (org)

Although I'm no ELisp guru, I also try to develop or contribute to useful packages:

* [[expand region|expand-region]] ([https://github.com/magnars/expand-region.el github page])
* isend-mode ([https://github.com/ffevotte/isend-mode.el github page])
* [[slurm|slurm.el]] ([https://github.com/ffevotte/slurm.el github page])

== Useful links ==

* [[WikEmacs:Guidelines]]
* [[:Category:Templates]]
* [[Special:Categories]]

[[Category:WikEmacs Contributor]]

User:Francesco

2012-12-10T10:19:57Z

Francesco: Undo revision 2919 by 58.9.149.154 (talk)

I use emacs on a daily basis, mostly for
* software development (C++, Python)
* document authoring (LaTeX)
* organizing my work (org)

== Useful links ==

* [[WikEmacs:Guidelines]]
* [[:Category:Templates]]
* [[Special:Categories]]

[[Category:WikEmacs Contributor]]

Trailing Whitespace

2012-07-31T13:04:24Z

Francesco: Page on trailing whitespace handling

There are different ways to handle trailing whitespace in Emacs

== Visualize trailing whitespace ==

Just set the {{Variable|show-trailing-whitespace}} variable:
{{Snippet|(setq show-trailing-whitespace t)}}

== Delete trailing whitespace ==

You can delete trailing whitespace in the entire buffer using {{Command|delete-trailing-whitespace}}.

To automate trailing whitespace deletion before saving the buffer in certain modes, you can add local hooks, e.g:
{{Snippet|(add-hook 'c-mode-hook (lambda () (add-to-list 'write-file-functions 'delete-trailing-whitespace)))}}

== See also ==

* [[Whitespace-mode]]

Ido

2012-07-23T20:39:30Z

Francesco: /* Helpful keybindings */ added C-j (ido-select-text)

{{Package
|name=Ido
|author = Kim F. Storm
|description=Interactive Do [[MiniBuffer]] Enhancement
|source=http://git.savannah.gnu.org/cgit/emacs.git/tree/lisp/ido.el
|maintainer=[[FSF]]
|in_emacs=yes
|Development status=active
}}

'''Ido''' - Interactively do things is a very convenient way to find files and switch buffers.

== Basic setup ==

<source lang="lisp">
(ido-mode)
(ido-everywhere 1)
</source>

== Helpful keybindings ==

; {{Keys|C-s}}
: Move to next ido suggestion.

; {{Keys|C-r}}
: Move to previous ido suggestion.

; {{Keys|C-f}}
: Temporarily revert to the default find-file behavior. Handy if [[ido]] won't behave as you'd like.

; {{Keys|C-j}}
: Accept the provided text as is, instead of selecting the currently proposed completion.

== Common Customization ==

=== Enable Fuzzy Matching ===

<syntaxhighlight lang="lisp">
(setq ido-enable-flex-matching t)
</syntaxhighlight>

=== Ignore Case ===

{{Snippet|(setq ido-case-fold t)}}

=== Virtual Buffers ===

If [[Recentf]] is enabled, you can use {{CommandKeys|C-x b|ido-switch-buffer}} to visit recently closed files by enabling virtual buffers:
{{Snippet|(setq ido-use-virtual-buffers t)}}

=== Prevent Auto-Merge ===

Ido's default behavior when there is no matching file in the current directory is to look in recent working directories. If you prefer to limit {{CommandKeys|C-x C-f|ido-find-file}} to the current directory you can disable this ''auto-merge'' behavior:
{{Snippet|(setq ido-auto-merge-work-directories-length -1) ;; disable auto-merge}}

You can still look in other working directories explicitly with {{Keys|M-s|ido-merge-work-directories}}.

=== Directory Caching on Windows ===

On [[Windows]] operating systems it can be unreliable to cache directory listings: the directory may not appear to be modified even though files have been added or removed. Ido caches directory listings by default, which may cause confusion on Windows. You can disable caching:

<syntaxhighlight lang="lisp">
(when (equal system-type 'windows-nt)
(setq ido-max-dir-file-cache 0)) ; caching unreliable
</syntaxhighlight>

=== Specifying sort-order ===
If you'd like to tweak the default file sorting, like making [[Org]]-files appear first, tell [[ido]] which files to give a higher sort priority:
<syntaxhighlight lang="lisp">
(setq ido-file-extensions-order '(".org" ".txt" ".py" ".emacs" ".xml" ".el"
".ini" ".cfg" ".conf"))
</syntaxhighlight>

== See Also ==

[[Helm]]

== External Links ==

[http://www.masteringemacs.org/articles/2010/10/10/introduction-to-ido-mode/ Introduction to Ido Mode]

[[Category:Completion]]
[[Category:Built-in Package]]
[[Category:MiniBuffer]]
[[Category:Convenience]]
[[Category:Minor Mode]]
[[Category:Buffer Navigation]]
[[Category:Popular Package]]

Flyspell-mode

2012-07-23T20:35:11Z

Francesco: /* See also */ added link to Spell check

{{Package
|name=flyspell-mode
|description=minor spell checking mode
|author=Manuel Serrano
|maintainer=[[FSF]]
|source=http://bzr.savannah.gnu.org/lh/emacs/emacs-24/annotate/head:/lisp/textmodes/flyspell.el
|in_emacs=yes
}}

'''flyspell-mode''' is a [[minor mode]] performing on-the-fly spelling checking. This spawns a single Ispell process and checks each word. The default flyspell behavior is to highlight incorrect words.

== Basic setup ==

<source lang="lisp">
(require 'flyspell)
(flyspell-mode +1)
</source>

== Helpful keybindings ==

; {{CommandKeys|M-$| ispell-word}}
: correct a word using ispell

; {{Command|flyspell-auto-correct-word}}
: automatically corrects the current word

; {{Command|flyspell-auto-correct-previous-word}}
: automatically corrects the previous word

; {{Command|flyspell-correct-word}}
: display a popup with correct word suggestions

; {{Command|flyspell-region}}
: runs flyspell on the selected region

; {{Command|flyspell-buffer}}
: runs flyspell on the current buffer

== Common Customization ==

== See Also ==

* [[Spell check]]

== Tutorial Pages ==

[[Category:Built-in Package]][[Category:Minor Mode]]

Whitespace-mode

2012-07-23T20:31:29Z

Francesco: Added author + minor changes

{{Package
|name=whitespace
|author=Vinicius Jose Latorre <viniciusjl@ig.com.br>
|description=visualizes white spaces in the buffer
|source=http://git.savannah.gnu.org/cgit/emacs.git/tree/lisp/whitespace.el
|maintainer=[[FSF]]
|in_emacs=yes
|Development status=active
}}

'''whitespace-mode''' is a [[minor mode]] to visualize blanks (tabs, spaces, newline, etc).

== Basic setup ==

Whitespace-mode is already bundled with Emacs.

Use {{Command|whitespace-mode}} to activate it on the current
[[buffer]], or add the following in your {{EmacsConfigFile}}:
<source lang="lisp">
(whitespace-mode 1)
</source>

You may also use {{Command|global-whitespace-mode}} to activate this mode globally for all buffers. The same effect is achieved by adding the following in your {{EmacsConfigFile}}:
<source lang="lisp">
(global-whitespace-mode 1)
</source>

[[Category:Minor Mode]]
[[Category:Built-in Package]]
[[Category:Visualize]]

Linum

2012-07-23T20:25:50Z

Francesco: added category: built-in package

{{Package
|name=linum
|description=display line numbers in the margin
|author=Markus Triska <markus.triska@gmx.at>
|maintainer=[[FSF]]
|source=http://git.savannah.gnu.org/cgit/emacs.git/tree/lisp/linum.el
|in_emacs=yes
}}

'''linum''' is a mode displaying line numbers in the left margin of the buffer.

== Basic setup ==

To globally enable '''linum''' for all buffers, add this to your {{EmacsConfigFile}}:
{{Snippet|(global-linum-mode 1)}}

You can also enable '''linum''' on a per-buffer basis using {{Command|linum-mode}}.

== See Also ==

* [[line-number]]
* [[column-number]]

[[Category:Minor Mode]]
[[Category:Built-in Package]]

Linum

2012-07-23T20:23:07Z

Francesco: Page about linum-mode

Rinari

2012-05-14T18:52:19Z

Francesco: added category

{{Package
|name=rinari
|description=Rinari: Ruby on Rails Minor Mode for Emacs
|maintainer=[[Steve Purcell]]
|source=https://github.com/eschulte/rinari
|in_emacs=no
|Development status=active
|website=http://rinari.rubyforge.org/
}}

'''R'''inari '''I'''s '''N'''ot '''A''' '''R'''uby '''I'''DE

The most integrated Emacs environment for Rails development.

= Features =

Rinari allows for full integrated flow on a Rails project. Some of the basic tasks are: starting the webserver, running rake tasks, invoking the console all within Emacs.

But the best feature of Rinari is that it facilitates "jumps" between different parts of a Rails based project. For example, when in '''app/model''' you can move to the corresponding RSpec based example or a controller... From a particular controller, you can jump to a corresponding view.

Those are not the only movements, you can move between any logically related parts of a Rails project. For a demo, see the screencast located on the project's homepage.

= Key bindings =

Keybindings that show what actions can be done while in Rinari mode:

;{{Keys|C-c ; '}}
: rinari-find-by-context
;{{Keys|C-c ; ;}}
: rinari-find-by-context
;{{Keys|C-c ; c}}
: rinari-console
;{{Keys|C-c ; d}}
: rinari-cap
;{{Keys|C-c ; e}}
: rinari-insert-erb-skeleton
;{{Keys|C-c ; f}}
: Prefix Command
;{{Keys|C-c ; g}}
: rinari-rgrep
;{{Keys|C-c ; p}}
: rinari-goto-partial
;{{Keys|C-c ; q}}
: rinari-sql
;{{Keys|C-c ; r}}
: rinari-rake
;{{Keys|C-c ; s}}
: rinari-script
;{{Keys|C-c ; t}}
: rinari-test
;{{Keys|C-c ; w}}
: rinari-web-server
;{{Keys|C-c ; x}}
: rinari-extract-partial

;{{Keys|C-c ; f ;}}
: rinari-find-by-context
;{{Keys|C-c ; f C}}
: rinari-find-cells
;{{Keys|C-c ; f F}}
: rinari-find-features
;{{Keys|C-c ; f M}}
: rinari-find-mailer
;{{Keys|C-c ; f S}}
: rinari-find-steps
;{{Keys|C-c ; f Y}}
: rinari-find-sass
;{{Keys|C-c ; f a}}
: rinari-find-application
;{{Keys|C-c ; f c}}
: rinari-find-controller
;{{Keys|C-c ; f e}}
: rinari-find-environment
;{{Keys|C-c ; f f}}
: rinari-find-file-in-project
;{{Keys|C-c ; f h}}
: rinari-find-helper
;{{Keys|C-c ; f i}}
: rinari-find-migration
;{{Keys|C-c ; f j}}
: rinari-find-javascript
;{{Keys|C-c ; f l}}
: rinari-find-lib
;{{Keys|C-c ; f m}}
: rinari-find-model
;{{Keys|C-c ; f n}}
: rinari-find-configuration
;{{Keys|C-c ; f o}}
: rinari-find-log
;{{Keys|C-c ; f p}}
: rinari-find-public
;{{Keys|C-c ; f r}}
: rinari-find-rspec
;{{Keys|C-c ; f s}}
: rinari-find-script
;{{Keys|C-c ; f t}}
: rinari-find-test
;{{Keys|C-c ; f u}}
: rinari-find-plugin
;{{Keys|C-c ; f v}}
: rinari-find-view
;{{Keys|C-c ; f w}}
: rinari-find-worker
;{{Keys|C-c ; f x}}
: rinari-find-fixture
;{{Keys|C-c ; f y}}
: rinari-find-stylesheet
;{{Keys|C-c ; f z}}
: rinari-find-rspec-fixture

[[Category:Third Party Package]][[Category:Minor Mode]]

Flyspell-mode

2012-05-14T18:49:24Z

Francesco: adde

{{Package
|name=flyspell-mode
|description=minor spell checking mode
|author=Manuel Serrano
|maintainer=[[FSF]]
|source=http://bzr.savannah.gnu.org/lh/emacs/emacs-24/annotate/head:/lisp/textmodes/flyspell.el
|in_emacs=yes
}}

'''flyspell-mode''' is a [[minor mode]] performing on-the-fly spelling checking. This spawns a single Ispell process and checks each word. The default flyspell behavior is to highlight incorrect words.

== Basic setup ==

<source lang="lisp">
(require 'flyspell)
(flyspell-mode +1)
</source>

== Helpful keybindings ==

; {{CommandKeys|M-$| ispell-word}}
: correct a word using ispell

; {{Command|flyspell-auto-correct-word}}
: automatically corrects the current word

; {{Command|flyspell-auto-correct-previous-word}}
: automatically corrects the previous word

; {{Command|flyspell-correct-word}}
: display a popup with correct word suggestions

; {{Command|flyspell-region}}
: runs flyspell on the selected region

; {{Command|flyspell-buffer}}
: runs flyspell on the current buffer

== Common Customization ==

== See Also ==

== Tutorial Pages ==

[[Category:Built-in Package]][[Category:Minor Mode]]

Quick Tutorial

2012-05-07T15:13:02Z

Francesco: /* Registers */ window configuration in registers

This reference-like tutorial is aimed at Emacs beginners and probably others too. If you know how to do some basic editing and navigation in Emacs and want to quickly go through more of its capabilities, then this tutorial is for you. If you are looking for the semantics or key-bindings of a specific feature, this tutorial aims to be for you since it is a subset of the online Emacs documentation. If you are giving an introductory presentation about Emacs, this tutorial might help you.

== Description and History ==

* Emacs is an extensible, customizable, self-documenting, real-time display text editor.
* Originally, a set of editing macros for the TECO editor.
* GNU Emacs was developed by R. Stallman and G. Steele.
* Technically, GNU Emacs is an elisp interpreter with text editing extensions.
* GNU Emacs contains thousands of commands and allows the user to combine them into elisp procedures (called macros) to automate work.
* Commands are, themselves, elisp procedures and the GNU Emacs configuration '''init''' file is an elisp program.

== Technical Description ==

; Extensible : The user can define, un-define and redefine commands as well as re-use available commands into macros.
; Customizable : The user can change properties of emacs elements including the key-bindings and the display.
; Self-documenting : All defined commands and macros get automatic preliminary documentation (bound keys and parameters).

== Why Emacs? ==

* Easily programmable
* Kill ring
* Rectangular editing
* Registers
* Command repetition
* Macros and Lisp procedures
* Modes
* Init file
* Remote files
* Shell, Terminal Emulator, IRC, Email, News, File Manager, Process Manager, Project Manager, Tetris, Doctor and many others.

== Terminology and Structure ==

{{details|Emacs Terminology}}

; Buffer : A container for data (text, completions)
; Point : The current position in the buffer (cursor)
; Window : A visual container for a buffer
; Frame : A visual container for one or more windows
; Kill : The equivalent of cutting
; Yank : The equivalent of copying
; Kill Ring : A circular clipboard (very handy)
; Mark : The coordinates of a selection
; Region : The text inside a mark
; Modeline : A status line
; Minibuffer : A small buffer for commands and arguments
; Mode : The current type of data being edited

== Modeline ==

The Modeline is used to report different pieces of information.

<pre>-cs:ch-fr buf pos line (major minor)-----</pre>

; cs : Character set (or coding system)
; : : Newline mode
; ch : File modification status
; - or @ : File is local or remote
; fr : Frame name on text terminals
; buf : Buffer/file name
; pos : Point/cursor position
; line : Current line and column number
; modes (major minor) : Currently loaded major and minor modes

== Keybind Terms and Minibuffer ==

Emacs has some different naming of command/control keys (probably coming from the old days).

; M : Meta key, Alt or ESC
; C : Control key
; S : Shift key
; {{Keys|M-a}} : Press '''a''' while holding the meta key
; {{Keys|C-M-a}} : Press '''a''' while holding the control and meta keys
; {{Keys|C-a b}} : Press '''a''' while holding the control key then press '''b'''
; {{Keys|C-a C-b}} : Press '''a''' and '''b''' both while holding the control key
; {{Keys|C-a M-b}} : Press '''a''' with control then '''b''' with meta

The Minibuffer is used to input commands, arguments and setting different modes (which some of are bound to keys or menu actions).

; {{Keys|M-x}} : Execute a command by name

== Basic Usage ==

=== Loading ===

; <pre>$ emacs # opens Emacs at the scratch buffer</pre>
; <pre>$ emacs [file1] [file2] ... # opens Emacs in split-window mode</pre>
; {{Keys|C-x C-f}} ''filename'' : loads a new buffer from ''filename''

=== Saving ===

; {{Keys|C-x C-s}} : saves the current buffer
; {{Keys|C-x C-w}} ''filename'' : saves the current buffer as ''filename''

=== Other ===

; {{Keys|C-x C-c}} : quits emacs
; {{Keys|C-g C-g}} : cancels key-sequence

== Windows ==

Windows are used to display buffer contents. Windows can be split and resized inside an Emacs frame. The minibuffer has its own window.

; {{Keys|C-x 2}} : open a window vertically
; {{Keys|C-x 3}} : open a window horizontally
; {{Keys|C-x 0}} : close the current window
; {{Keys|C-x 1}} : close all other windows
; ESC ESC ESC : close all other windows
; {{Keys|C-x o}} : move to another window
; {{Keys|C-x ^}} : increase window size vertically
; {{Keys|C-x } }} : increase window size horizontally
; {{Keys|C-x {}} : decrease window size horizontally
; {{Keys|C-x -}} : shrink window to buffer size
; {{Keys|C-x +}} : make all windows equal in size

== Navigation and Movement ==

=== Word ===

; {{Keys|C-←}} : moves one word backwards
; {{Keys|C-→}} : moves one word forward

=== Line ===

; {{Keys|C-a}} : goes to beginning of the line (Home)
; {{Keys|C-e}} : goes to end of the line (End)
; {{Keys|M-a}} : goes to beginning of the sentence
; {{Keys|M-e}} : goes to end of the sentence
; {{Keys|M-g g}} : goes to given line by number
; {{Keys|M-m}} : moves point to the first non-whitespace character in this line

=== Paragraph ===

; {{Keys|C-↑}} : moves up one paragraph
; {{Keys|C-↓}} : moves down one paragraph

=== Window ===
; {{Keys|M-0 M-r}} : moves to the top of window
; {{Keys|M-r}} : moves to the middle of window
; {{Keys|M-- M-r}} : moves to the bottom of window

=== Buffer ===

; {{Keys|C-x [}} : moves to the beginning of the buffer
; {{Keys|C-x ]}} : moves to the end of the buffer
; {{Keys|C-l}} : moves the buffer to position point
; {{Keys|C-x b}} : switches to another buffer by name
; {{Keys|C-x ←}} or {{Keys|C-x →}} : switches to previous or next buffer
; {{Keys|C-x k}} : kills the current buffer

== Editing ==

=== Character ===

; {{Keys|C-d}} : deletes next character
; {{Keys|C-t}} : transposes current character with previous one
; {{Keys|C-q TAB}} : inserts a TAB verbatim

=== Word ===

; {{Keys|M-d}} : kills the next word
; {{Keys|M-- M-d}} : kills to the previous word
; {{Keys|M-/}} : expands current word
; {{Keys|M-/ SPC M-/}} : expands current word and grabs next one
; {{Keys|M-C-/}} : completes current word
; {{Keys|M-t}} : transposes current word with next one
; {{Keys|M-- M-t}} : transposes current word with previous one
; {{Keys|M-c}} : capitalizes next word
; {{Keys|M-- M-c}} : capitalizes previous word
; {{Keys|M-l}} : lowercase next word
; {{Keys|M-- M-l}} : lowercase previous word
; {{Keys|M-u}} : uppercase next word
; {{Keys|M-- M-u}} : uppercase previous word

=== Line ===

; {{Keys|M-o M-s}} : center a line
; {{Keys|C-S-BACKSPC}} : kills current line
; {{Keys|C-k}} : kills from point to EOL
; {{Keys|M-u C-k}} : kills to the previous line
; {{Keys|C-a C-k}} : goes to BOL then kills to EOL
; {{Keys|TAB}} : indents line depending on current mode
; {{Keys|C-o}} : breaks line before/after point
; {{Keys|C-x C-t}} : transpose current line with previous one
; {{Keys|M-0 C-x}} C-t : transpose current line with one at mark
; delete-matching-lines : delete lines matching a regexp

== Prefix Arguments and Command Repetition ==

Passing numerical arguments to commands can alter their behavior (e.g., repetition or inversion). Passing an argument can be done before M-x or key bindings.

; {{Keys|M-''n'' ''com''}} : run ''com'' with prefix arg ''n''
; {{Keys|M-- ''com''}} : run ''com'' with negative prefix arg
; {{Keys|C-u ''n'' ''com''}} : run ''com'' with prefix arg ''n''
; {{Keys|C-u ''com''}} : run ''com'' with prefix arg 4 (the default)
; {{Keys|C-u C-u ''com''}} : run ''com'' with prefix arg 16 (four times the four times the default)
; {{Keys|C-u C-u ''com''}} : run ''com'' with prefix arg 64 (four times the four times the four times the default)
; {{Keys|C-u}} : also terminates the prefix argument
; {{Keys|C-x [z]+}} : repeats the previous z''th'' command (including its args)
; {{Keys|C-x ESC ESC}} : repeats last command that used the minibuffer

=== Examples ===

; {{Keys|C-u 5 0 C-k}} : will kill 50 lines
; {{Keys|C-u 5 C-u 0}} : will insert 5 zeros

== Search and Replace ==

=== Incremental search ===

{{Details|Incremental Search}}

; {{Keys|C-s keyword}} : search forward
; {{Keys|C-r keyword}} : search backward

=== Non-incremental search ===

; {{Keys|C-s RET keyword}} : search forward
; {{Keys|C-r RET keyword}} : search backward

=== Regular Expression Search ===

{{Details|Regexp Search}}

; {{Keys|C-M-s expression}} : search regexp forward
; {{Keys|C-M-r expression}} : search regexp backward

=== Notes ===

* '''ESC''' will cancel and go to original point. '''RET''' will end at the current point.
* Searches are case-insensitive unless an uppercase letter is found in the search string.
* While searching, {{Keys|C-w}} will increment the search term with the current word.

=== Unconditional Replace ===

; replace-string : replaces a string with another
; replace-regexp : replaces a regexp match with a string

=== Query Replace (Conditional Replace) ===

; {{Keys|M-%}} : conditional replacement of a string
; query-replace-regexp : conditional replacement of a regular expression

=== Notes ===

* Replaces are case-insensitive unless an uppercase letter is found in the match string.
* Replaces work from position to end of buffer unless a mark is active.
* After a replace, the position will be at the end of the last match. {{Keys|C-u C-SPC}} to go back to the position before the replace started.
* During a query replace, '''SPC''' will apply a replace and '''DEL''' will skip.

== Undo and Redo ==

In Emacs, there is no special redo function. Instead, there is only an undo function and redo can be achieved by ''undo-ing'' an undo.

; {{Keys|C-/}} : undo a single change
; {{Keys|C-g}} : break the chain of undos

=== Notes ===

* If a mark is active, undo will only affect the marked region.

== Regions ==

Emacs uses the mark and point to denote a [[Region|region]] (i.e., a selection).

; {{Keys|C-SPC}} : creates a region (marks area)
; {{Keys|C-x C-x}} : swaps mark and point in a region
; {{Keys|C-u C-x C-x}} : swaps mark and point without region
; {{Keys|C-x h}} : marks the entire buffer
; {{Keys|M-h}} : marks the paragraph around the point
; {{Keys|TAB}} : indents the current region
; {{Keys|M-@}} : incrementally mark next word

=== Kill, Yank and Paste Regions ===

; {{Keys|C-w}} : kills the currently selected region
; {{Keys|M-w}} : copies the currently selected region
; {{Keys|C-y}} ({{Keys|M-y}})* : yanks and cycles from the kill ring

=== Notes ===

* Yank is the copy command in vi and the paste command in emacs.

== Rectangles ==

[[Rectangles]] are marked regions between the columns of the point and the mark. Applying operations on rectangles is some sort of vertical editing.

; {{Keys|C-x r k}} : kill the rectangle
; {{Keys|C-x r d}} : delete the rectangle
; {{Keys|C-x r y}} : yank the last killed rectangle
; {{Keys|C-x r o}} : push text to fill rectangle with spaces (open)
; {{Keys|C-x r c}} : replace rectangle text with spaces (clear)
; {{Keys|C-x r t}} : replace each line in rectangle with text

== Registers ==

[[Registers]] are places where you can store anything: text, position, rectangle, configuration, filename, etc... Registers are named with single character symbols: ''a'', ''A'' and ''3'' are three different registers.

; view-register : view the contents of a register
; {{Keys|C-x r SPC ''r''}} : record current point position in register ''r''
; {{Keys|C-x r w ''r''}} : record current window configuration in register ''r''
; {{Keys|C-x r j ''r''}} : jump to position (or window configuration) in register ''r''
; {{Keys|C-x r s ''r''}} : save region to register ''r''
; {{Keys|C-u C-x r s ''r''}} : kill region to register ''r''
; {{Keys|C-x r i ''r''}} : insert text from register ''r''
; append-to-register : append region to register
; prepend-to-register : prepend region to register
; {{Keys|C-x r r ''r''}} : save rectangle into register ''r''

== Bookmarks ==

[[Bookmarks]] are like registers but persistent. They can also be named.

; {{Keys|C-x r m ''foo''}} : bookmark file and point to ''foo''
; {{Keys|C-x r b ''foo''}} : jump to bookmark called ''foo''
; {{Keys|C-x r l}} : list all bookmarks
; bookmark-save : save all bookmarks
; bookmark-delete : delete a bookmark

== Macros ==

[[Keyboard macros]] are user defined commands using the Emacs command language. A user can ''record'' and ''replay'' a macro, useful for simple repeatable tasks. More complex tasks (e.g., conditions, loops) must be implemented in ''elisp''. Macros are recorded in a macro ring.

; {{Keys|F3}} : start macro definition or insert counter
; {{Keys|C-x (}} : start macro definition only
; {{Keys|F4}} : end macro definition or call macro
; {{Keys|C-x e}} : end macro definition and call macro
; {{Keys|C-x )}} : end macro definition only
; {{Keys|C-u C-u F3}} : append commands to last macro
; {{Keys|C-u F3}} : re-run last macro then append commands to it
; {{Keys|C-x C-k r}} : run macro on region
; {{Keys|C-x C-k C-n}} : rotate to select the next macro in the ring
; {{Keys|C-x C-k C-p}} : rotate to select the previous macro in the ring

=== Macro Counters ===

Every macro definition can have a counter to insert into the buffer.

; {{Keys|F3}} : inside a macro definition, inserts the counter
; {{Keys|C-x C-k C-i}} : outside a macro definition, inserts the counter
; {{Keys|C-x C-k C-c}} : set the macro counter value
; {{Keys|C-x C-k C-f}} : set the macro counter format

=== Saving Macros ===

Macros can be named and saved.

; {{Keys|C-x C-k n}} : name the most recently defined macro
; {{Keys|C-x C-k b}} : keybind the most recently defined macro
; insert-kbd-macro : insert macro into buffer as elisp code

=== Notes ===

* It is best to use the reserved key bindings {{Keys|C-x C-k [a-zA-Z0-9]}} as to not cause problems with other bindings. {{Keys|C-x C-k b 4}} will define {{Keys|C-x C-k 4}} as a binding.

== Alignment ==

Emacs contains alignment commands. Sometimes those depend on the current mode (i.e., the language).

; align : aligns depending on mode
; align-regexp : aligns using a regular expression
; {{Keys|C-u align-regexp}} : aligns using a regular expression helper
; align-current : aligns current paragraph depending on mode

== Sorting ==

When sorting, prefixing with {{Keys|C-u}} sorts in descending order.

; sort-lines : sort region by lines
; sort-paragraphs : sort region by paragraphs
; {{Keys|C-u ''n'' sort-fields}} : sort lines in region by n''th'' field
; {{Keys|C-u -''n'' sort-fields}} : sort lines in region by n''th'' field from right
; sort-numeric-fields : interpret field as number and not text
; sort-columns : sort by column specified by marked region
; reverse-region : reverses current region

== Tables ==

Emacs has support for creating and editing text-based tables by keeping track of their properties (e.g., position, size) in the buffer. When a buffer is saved to file, those properties are lost.

; table-insert : interactively insert a table into buffer
; table-recognize : detect properties of all tables in the buffer
; table-unrecognize : remove special table properties
; table-recognize-region : detect properties of tables in region
; table-unrecognize-region : forget properties of tables in region
; table-recognize-table : detect properties of table at point
; table-unrecognize-table : remove properties of table at point

=== Cell resizing ===

; {{Keys|C-u ''n'' C->}} : widen cell at point by ''n'' characters
; {{Keys|C-u ''n'' C-<}} : narrow cell at point by ''n'' characters
; {{Keys|C-u ''n'' C-｝}} : heighten cell at point by ''n'' lines
; {{Keys|C-u ''n'' C-｛}} : shorten cell at point by ''n'' lines

=== Cell movement ===

; {{Keys|TAB}} : move to cell on right
; {{Keys|S-TAB}} : move to cell on left

=== Cell merging and splitting ===

; {{Keys|C-c C-c *}} : interactively merge two cells
; {{Keys|C-+}} : split cell horizontally
; {{Keys|C--}} : split cell vertically

=== Rows and Columns ===

; {{Keys|C-u ''n'' table-insert-row}} : insert ''n'' rows
; {{Keys|C-u ''n'' table-delete-row}} : delete ''n'' rows
; {{Keys|C-u ''n'' table-insert-column}} : insert ''n'' columns
; {{Keys|C-u ''n'' table-delete-column}} : delete ''n'' columns

=== Other ===

; {{Keys|C-:}} : interactively justify cell, column or row text
; {{Keys|C-!}} : toggle table fixed width mode
; table-generate-source : table code in Latex, HTML or Cals

== Goodies ==

; {{Keys|C-x TAB}} : force an indentation on a region
; {{Keys|M-q}} : indents and breaks paragraph into multiple lines
; {{Keys|M-;}} : comments a region or adds comment to line
; {{Keys|M-(}} : inserts a new lisp function (parenthesis)
; {{Keys|M-)}} : checks balanced parenthesis and opens line
; {{Keys|C-x i}} : inserts file contents at point position
; {{Keys|M-!}} : run shell command
; {{Keys|C-u M-!}} : run shell command and insert output
; {{Keys|M-❘}} : run shell command on marked region
; {{Keys|C-u M-❘}} : run shell command on and replace marked region
; insert-buffer : inserts buffer contents at point position
; copy-to-buffer : copy region content to a buffer
; kill-some-buffers : interactively kill buffers
; electric-buffer-list : interactive buffer list
; toggle-truncate-lines : do not split lines over visual lines
; visual-line-mode : split lines by words
; viper-mode : vi compatibility mode

== Setting Key Bindings ==

{{Details|Key Bindings}}

Emacs has a global keymap which maps between keys and commands. Each major mode can define, re-define or un-define its own key bindings, creating a local keymap (e.g., c-mode). Each minor mode can do so too (e.g., flymake). Each portion of text can also do so (e.g., tables).

=== Some prefix keys ===

; {{Keys|C-x}} : command prefix key
; {{Keys|M-}} : command prefix key
; {{Keys|C-c}} : mode specific prefix key
; {{Keys|C-h}} : help prefix key

=== Commands to bind keys ===

; global-set-key ''k'' ''com'' : bind key ''k'' to ''com'' globally
; local-set-key ''k'' ''com'' : bind key ''k'' to ''com'' locally (major mode)

=== Notes ===

* Menu and mouse key bindings can also be set.

== Storing Key Bindings ==

In the Emacs ''init'' file, you can either set global key bindings or ''hook'' local key bindings to mode hooks (i.e., callbacks, slots).

; global-set-key : adds a binding to the global map
; local-set-key : adds a binding to the local (major mode) map
; kbd : converts a string to a key sequence

=== Examples ===

==== Global key binding ====

<source lang="lisp">
(global-set-key (kbd 'C-c d') 'duplicate-line)
(global-set-key (kbd 'C-c d') (kbd 'C-a C-@ C-e M-w RET C-y'))
(global-set-key (kbd 'C-c d') '\C-a\C- \C-n\M-w\C-y')
</source>

==== Local key binding ====

<source lang="lisp">
(add-hook 'LaTeX-mode-hook (lambda () (local-set-key (kbd 'C-c n') 'forward-paragraph)))
</source>

== The Emacs Help System ==

Emacs has a handy help system for quick lookup of various features, topics, functions and key bindings.

; {{Keys|C-h ?}} : show the help system shortcuts
; {{Keys|C-h ''key''}} : run help system with shortcut ''key''

=== Some useful help keys ===

; {{Keys|C-h a}} : show apropos page about a keyword
; {{Keys|C-h k ''keybind''}} : show help for function bound to ''keybind''
; {{Keys|C-h b}} : show all key bindings
; {{Keys|C-h f}} : show documentation for function
; {{Keys|C-h m}} : show documentation for current modes
; {{Keys|C-h v}} : show documentation for variable
; {{Keys|C-h w}} : show what keys a command is bound to
; {{Keys|C-h t}} : start the emacs tutorial
; {{Keys|''prefix'' C-h}} : show all key binds starting with ''prefix''

== Modes ==

Modes are used to define the type of data being edited in buffers, or what Emacs calls “the language”.

Every buffer has exactly one [[Major mode|major mode]] which defines its language (C, Java, English, IRC, etc...) and provides basic elements like syntax highlighting and (re)defines functions and their key bindings for relevant actions (e.g., comments).

Each buffer can have zero or more [[Minor mode|minor modes]] enabled which provide non-specific functionality such as spell checking or line wrapping (i.e., mode independent).

== Mode: ediff ==

ediff (emacs-diff) is a mode for Emacs where you can view and merge differences between two or three buffers.

; ediff : select files to view their differences
; ediff-buffers : select buffers to view their differences

=== In ediff-mode ===

; | : switch between horizontal/vertical view
; ? : view ediff help
; p : view previous difference
; n : view next difference
; a : set buffer b’s area to what’s in a’s
; b : set buffer a’s area to what’s in b’s
; q : quit ediff session

== Mode: Spell Checking ==

{{Details|Spell check}}

; {{Keys|M-$}} : check spelling at word or active region
; ispell : check active region or buffer, during which pressing '''i''' will accept the current word and insert it into the user's dictionary, pressing '''?''' will show help and pressing '''RET''' will end the current '''ispell''' session.
; {{Keys|ESC TAB}} : complete current word from dictionary
; flyspell-mode : enable “on the fly” spell checking
; flyspell-prog-mode : spell check comments and strings (programming mode)

== References ==

* Emacs Wiki: http://emacswiki.org/
* Emacs Docs: https://www.gnu.org/software/emacs/manual/html_node/emacs/index.html
* Emacs Help

[[Category:Tutorial]]

Quick Tutorial

2012-05-07T15:07:34Z

Francesco: /* Navigation and Movement */ fixed key binding

This reference-like tutorial is aimed at Emacs beginners and probably others too. If you know how to do some basic editing and navigation in Emacs and want to quickly go through more of its capabilities, then this tutorial is for you. If you are looking for the semantics or key-bindings of a specific feature, this tutorial aims to be for you since it is a subset of the online Emacs documentation. If you are giving an introductory presentation about Emacs, this tutorial might help you.

== Description and History ==

* Emacs is an extensible, customizable, self-documenting, real-time display text editor.
* Originally, a set of editing macros for the TECO editor.
* GNU Emacs was developed by R. Stallman and G. Steele.
* Technically, GNU Emacs is an elisp interpreter with text editing extensions.
* GNU Emacs contains thousands of commands and allows the user to combine them into elisp procedures (called macros) to automate work.
* Commands are, themselves, elisp procedures and the GNU Emacs configuration '''init''' file is an elisp program.

== Technical Description ==

; Extensible : The user can define, un-define and redefine commands as well as re-use available commands into macros.
; Customizable : The user can change properties of emacs elements including the key-bindings and the display.
; Self-documenting : All defined commands and macros get automatic preliminary documentation (bound keys and parameters).

== Why Emacs? ==

* Easily programmable
* Kill ring
* Rectangular editing
* Registers
* Command repetition
* Macros and Lisp procedures
* Modes
* Init file
* Remote files
* Shell, Terminal Emulator, IRC, Email, News, File Manager, Process Manager, Project Manager, Tetris, Doctor and many others.

== Terminology and Structure ==

{{details|Emacs Terminology}}

; Buffer : A container for data (text, completions)
; Point : The current position in the buffer (cursor)
; Window : A visual container for a buffer
; Frame : A visual container for one or more windows
; Kill : The equivalent of cutting
; Yank : The equivalent of copying
; Kill Ring : A circular clipboard (very handy)
; Mark : The coordinates of a selection
; Region : The text inside a mark
; Modeline : A status line
; Minibuffer : A small buffer for commands and arguments
; Mode : The current type of data being edited

== Modeline ==

The Modeline is used to report different pieces of information.

<pre>-cs:ch-fr buf pos line (major minor)-----</pre>

; cs : Character set (or coding system)
; : : Newline mode
; ch : File modification status
; - or @ : File is local or remote
; fr : Frame name on text terminals
; buf : Buffer/file name
; pos : Point/cursor position
; line : Current line and column number
; modes (major minor) : Currently loaded major and minor modes

== Keybind Terms and Minibuffer ==

Emacs has some different naming of command/control keys (probably coming from the old days).

; M : Meta key, Alt or ESC
; C : Control key
; S : Shift key
; {{Keys|M-a}} : Press '''a''' while holding the meta key
; {{Keys|C-M-a}} : Press '''a''' while holding the control and meta keys
; {{Keys|C-a b}} : Press '''a''' while holding the control key then press '''b'''
; {{Keys|C-a C-b}} : Press '''a''' and '''b''' both while holding the control key
; {{Keys|C-a M-b}} : Press '''a''' with control then '''b''' with meta

The Minibuffer is used to input commands, arguments and setting different modes (which some of are bound to keys or menu actions).

; {{Keys|M-x}} : Execute a command by name

== Basic Usage ==

=== Loading ===

; <pre>$ emacs # opens Emacs at the scratch buffer</pre>
; <pre>$ emacs [file1] [file2] ... # opens Emacs in split-window mode</pre>
; {{Keys|C-x C-f}} ''filename'' : loads a new buffer from ''filename''

=== Saving ===

; {{Keys|C-x C-s}} : saves the current buffer
; {{Keys|C-x C-w}} ''filename'' : saves the current buffer as ''filename''

=== Other ===

; {{Keys|C-x C-c}} : quits emacs
; {{Keys|C-g C-g}} : cancels key-sequence

== Windows ==

Windows are used to display buffer contents. Windows can be split and resized inside an Emacs frame. The minibuffer has its own window.

; {{Keys|C-x 2}} : open a window vertically
; {{Keys|C-x 3}} : open a window horizontally
; {{Keys|C-x 0}} : close the current window
; {{Keys|C-x 1}} : close all other windows
; ESC ESC ESC : close all other windows
; {{Keys|C-x o}} : move to another window
; {{Keys|C-x ^}} : increase window size vertically
; {{Keys|C-x } }} : increase window size horizontally
; {{Keys|C-x {}} : decrease window size horizontally
; {{Keys|C-x -}} : shrink window to buffer size
; {{Keys|C-x +}} : make all windows equal in size

== Navigation and Movement ==

=== Word ===

; {{Keys|C-←}} : moves one word backwards
; {{Keys|C-→}} : moves one word forward

=== Line ===

; {{Keys|C-a}} : goes to beginning of the line (Home)
; {{Keys|C-e}} : goes to end of the line (End)
; {{Keys|M-a}} : goes to beginning of the sentence
; {{Keys|M-e}} : goes to end of the sentence
; {{Keys|M-g g}} : goes to given line by number
; {{Keys|M-m}} : moves point to the first non-whitespace character in this line

=== Paragraph ===

; {{Keys|C-↑}} : moves up one paragraph
; {{Keys|C-↓}} : moves down one paragraph

=== Window ===
; {{Keys|M-0 M-r}} : moves to the top of window
; {{Keys|M-r}} : moves to the middle of window
; {{Keys|M-- M-r}} : moves to the bottom of window

=== Buffer ===

; {{Keys|C-x [}} : moves to the beginning of the buffer
; {{Keys|C-x ]}} : moves to the end of the buffer
; {{Keys|C-l}} : moves the buffer to position point
; {{Keys|C-x b}} : switches to another buffer by name
; {{Keys|C-x ←}} or {{Keys|C-x →}} : switches to previous or next buffer
; {{Keys|C-x k}} : kills the current buffer

== Editing ==

=== Character ===

; {{Keys|C-d}} : deletes next character
; {{Keys|C-t}} : transposes current character with previous one
; {{Keys|C-q TAB}} : inserts a TAB verbatim

=== Word ===

; {{Keys|M-d}} : kills the next word
; {{Keys|M-- M-d}} : kills to the previous word
; {{Keys|M-/}} : expands current word
; {{Keys|M-/ SPC M-/}} : expands current word and grabs next one
; {{Keys|M-C-/}} : completes current word
; {{Keys|M-t}} : transposes current word with next one
; {{Keys|M-- M-t}} : transposes current word with previous one
; {{Keys|M-c}} : capitalizes next word
; {{Keys|M-- M-c}} : capitalizes previous word
; {{Keys|M-l}} : lowercase next word
; {{Keys|M-- M-l}} : lowercase previous word
; {{Keys|M-u}} : uppercase next word
; {{Keys|M-- M-u}} : uppercase previous word

=== Line ===

; {{Keys|M-o M-s}} : center a line
; {{Keys|C-S-BACKSPC}} : kills current line
; {{Keys|C-k}} : kills from point to EOL
; {{Keys|M-u C-k}} : kills to the previous line
; {{Keys|C-a C-k}} : goes to BOL then kills to EOL
; {{Keys|TAB}} : indents line depending on current mode
; {{Keys|C-o}} : breaks line before/after point
; {{Keys|C-x C-t}} : transpose current line with previous one
; {{Keys|M-0 C-x}} C-t : transpose current line with one at mark
; delete-matching-lines : delete lines matching a regexp

== Prefix Arguments and Command Repetition ==

Passing numerical arguments to commands can alter their behavior (e.g., repetition or inversion). Passing an argument can be done before M-x or key bindings.

; {{Keys|M-''n'' ''com''}} : run ''com'' with prefix arg ''n''
; {{Keys|M-- ''com''}} : run ''com'' with negative prefix arg
; {{Keys|C-u ''n'' ''com''}} : run ''com'' with prefix arg ''n''
; {{Keys|C-u ''com''}} : run ''com'' with prefix arg 4 (the default)
; {{Keys|C-u C-u ''com''}} : run ''com'' with prefix arg 16 (four times the four times the default)
; {{Keys|C-u C-u ''com''}} : run ''com'' with prefix arg 64 (four times the four times the four times the default)
; {{Keys|C-u}} : also terminates the prefix argument
; {{Keys|C-x [z]+}} : repeats the previous z''th'' command (including its args)
; {{Keys|C-x ESC ESC}} : repeats last command that used the minibuffer

=== Examples ===

; {{Keys|C-u 5 0 C-k}} : will kill 50 lines
; {{Keys|C-u 5 C-u 0}} : will insert 5 zeros

== Search and Replace ==

=== Incremental search ===

{{Details|Incremental Search}}

; {{Keys|C-s keyword}} : search forward
; {{Keys|C-r keyword}} : search backward

=== Non-incremental search ===

; {{Keys|C-s RET keyword}} : search forward
; {{Keys|C-r RET keyword}} : search backward

=== Regular Expression Search ===

{{Details|Regexp Search}}

; {{Keys|C-M-s expression}} : search regexp forward
; {{Keys|C-M-r expression}} : search regexp backward

=== Notes ===

* '''ESC''' will cancel and go to original point. '''RET''' will end at the current point.
* Searches are case-insensitive unless an uppercase letter is found in the search string.
* While searching, {{Keys|C-w}} will increment the search term with the current word.

=== Unconditional Replace ===

; replace-string : replaces a string with another
; replace-regexp : replaces a regexp match with a string

=== Query Replace (Conditional Replace) ===

; {{Keys|M-%}} : conditional replacement of a string
; query-replace-regexp : conditional replacement of a regular expression

=== Notes ===

* Replaces are case-insensitive unless an uppercase letter is found in the match string.
* Replaces work from position to end of buffer unless a mark is active.
* After a replace, the position will be at the end of the last match. {{Keys|C-u C-SPC}} to go back to the position before the replace started.
* During a query replace, '''SPC''' will apply a replace and '''DEL''' will skip.

== Undo and Redo ==

In Emacs, there is no special redo function. Instead, there is only an undo function and redo can be achieved by ''undo-ing'' an undo.

; {{Keys|C-/}} : undo a single change
; {{Keys|C-g}} : break the chain of undos

=== Notes ===

* If a mark is active, undo will only affect the marked region.

== Regions ==

Emacs uses the mark and point to denote a [[Region|region]] (i.e., a selection).

; {{Keys|C-SPC}} : creates a region (marks area)
; {{Keys|C-x C-x}} : swaps mark and point in a region
; {{Keys|C-u C-x C-x}} : swaps mark and point without region
; {{Keys|C-x h}} : marks the entire buffer
; {{Keys|M-h}} : marks the paragraph around the point
; {{Keys|TAB}} : indents the current region
; {{Keys|M-@}} : incrementally mark next word

=== Kill, Yank and Paste Regions ===

; {{Keys|C-w}} : kills the currently selected region
; {{Keys|M-w}} : copies the currently selected region
; {{Keys|C-y}} ({{Keys|M-y}})* : yanks and cycles from the kill ring

=== Notes ===

* Yank is the copy command in vi and the paste command in emacs.

== Rectangles ==

[[Rectangles]] are marked regions between the columns of the point and the mark. Applying operations on rectangles is some sort of vertical editing.

; {{Keys|C-x r k}} : kill the rectangle
; {{Keys|C-x r d}} : delete the rectangle
; {{Keys|C-x r y}} : yank the last killed rectangle
; {{Keys|C-x r o}} : push text to fill rectangle with spaces (open)
; {{Keys|C-x r c}} : replace rectangle text with spaces (clear)
; {{Keys|C-x r t}} : replace each line in rectangle with text

== Registers ==

[[Registers]] are places where you can store anything: text, position, rectangle, configuration, filename, etc... Registers are named with single character symbols: ''a'', ''A'' and ''3'' are three different registers.

; view-register : view the contents of a register
; {{Keys|C-x r SPC ''r''}} : record current point position in register ''r''
; {{Keys|C-x r j ''r''}} : jump to position in register ''r''
; {{Keys|C-x r s ''r''}} : save region to register ''r''
; {{Keys|C-u C-x r s ''r''}} : kill region to register ''r''
; {{Keys|C-x r i ''r''}} : insert text from register ''r''
; append-to-register : append region to register
; prepend-to-register : prepend region to register
; {{Keys|C-x r r ''r''}} : save rectangle into register ''r''

== Bookmarks ==

[[Bookmarks]] are like registers but persistent. They can also be named.

; {{Keys|C-x r m ''foo''}} : bookmark file and point to ''foo''
; {{Keys|C-x r b ''foo''}} : jump to bookmark called ''foo''
; {{Keys|C-x r l}} : list all bookmarks
; bookmark-save : save all bookmarks
; bookmark-delete : delete a bookmark

== Macros ==

[[Keyboard macros]] are user defined commands using the Emacs command language. A user can ''record'' and ''replay'' a macro, useful for simple repeatable tasks. More complex tasks (e.g., conditions, loops) must be implemented in ''elisp''. Macros are recorded in a macro ring.

; {{Keys|F3}} : start macro definition or insert counter
; {{Keys|C-x (}} : start macro definition only
; {{Keys|F4}} : end macro definition or call macro
; {{Keys|C-x e}} : end macro definition and call macro
; {{Keys|C-x )}} : end macro definition only
; {{Keys|C-u C-u F3}} : append commands to last macro
; {{Keys|C-u F3}} : re-run last macro then append commands to it
; {{Keys|C-x C-k r}} : run macro on region
; {{Keys|C-x C-k C-n}} : rotate to select the next macro in the ring
; {{Keys|C-x C-k C-p}} : rotate to select the previous macro in the ring

=== Macro Counters ===

Every macro definition can have a counter to insert into the buffer.

; {{Keys|F3}} : inside a macro definition, inserts the counter
; {{Keys|C-x C-k C-i}} : outside a macro definition, inserts the counter
; {{Keys|C-x C-k C-c}} : set the macro counter value
; {{Keys|C-x C-k C-f}} : set the macro counter format

=== Saving Macros ===

Macros can be named and saved.

; {{Keys|C-x C-k n}} : name the most recently defined macro
; {{Keys|C-x C-k b}} : keybind the most recently defined macro
; insert-kbd-macro : insert macro into buffer as elisp code

=== Notes ===

* It is best to use the reserved key bindings {{Keys|C-x C-k [a-zA-Z0-9]}} as to not cause problems with other bindings. {{Keys|C-x C-k b 4}} will define {{Keys|C-x C-k 4}} as a binding.

== Alignment ==

Emacs contains alignment commands. Sometimes those depend on the current mode (i.e., the language).

; align : aligns depending on mode
; align-regexp : aligns using a regular expression
; {{Keys|C-u align-regexp}} : aligns using a regular expression helper
; align-current : aligns current paragraph depending on mode

== Sorting ==

When sorting, prefixing with {{Keys|C-u}} sorts in descending order.

; sort-lines : sort region by lines
; sort-paragraphs : sort region by paragraphs
; {{Keys|C-u ''n'' sort-fields}} : sort lines in region by n''th'' field
; {{Keys|C-u -''n'' sort-fields}} : sort lines in region by n''th'' field from right
; sort-numeric-fields : interpret field as number and not text
; sort-columns : sort by column specified by marked region
; reverse-region : reverses current region

== Tables ==

Emacs has support for creating and editing text-based tables by keeping track of their properties (e.g., position, size) in the buffer. When a buffer is saved to file, those properties are lost.

; table-insert : interactively insert a table into buffer
; table-recognize : detect properties of all tables in the buffer
; table-unrecognize : remove special table properties
; table-recognize-region : detect properties of tables in region
; table-unrecognize-region : forget properties of tables in region
; table-recognize-table : detect properties of table at point
; table-unrecognize-table : remove properties of table at point

=== Cell resizing ===

; {{Keys|C-u ''n'' C->}} : widen cell at point by ''n'' characters
; {{Keys|C-u ''n'' C-<}} : narrow cell at point by ''n'' characters
; {{Keys|C-u ''n'' C-｝}} : heighten cell at point by ''n'' lines
; {{Keys|C-u ''n'' C-｛}} : shorten cell at point by ''n'' lines

=== Cell movement ===

; {{Keys|TAB}} : move to cell on right
; {{Keys|S-TAB}} : move to cell on left

=== Cell merging and splitting ===

; {{Keys|C-c C-c *}} : interactively merge two cells
; {{Keys|C-+}} : split cell horizontally
; {{Keys|C--}} : split cell vertically

=== Rows and Columns ===

; {{Keys|C-u ''n'' table-insert-row}} : insert ''n'' rows
; {{Keys|C-u ''n'' table-delete-row}} : delete ''n'' rows
; {{Keys|C-u ''n'' table-insert-column}} : insert ''n'' columns
; {{Keys|C-u ''n'' table-delete-column}} : delete ''n'' columns

=== Other ===

; {{Keys|C-:}} : interactively justify cell, column or row text
; {{Keys|C-!}} : toggle table fixed width mode
; table-generate-source : table code in Latex, HTML or Cals

== Goodies ==

; {{Keys|C-x TAB}} : force an indentation on a region
; {{Keys|M-q}} : indents and breaks paragraph into multiple lines
; {{Keys|M-;}} : comments a region or adds comment to line
; {{Keys|M-(}} : inserts a new lisp function (parenthesis)
; {{Keys|M-)}} : checks balanced parenthesis and opens line
; {{Keys|C-x i}} : inserts file contents at point position
; {{Keys|M-!}} : run shell command
; {{Keys|C-u M-!}} : run shell command and insert output
; {{Keys|M-❘}} : run shell command on marked region
; {{Keys|C-u M-❘}} : run shell command on and replace marked region
; insert-buffer : inserts buffer contents at point position
; copy-to-buffer : copy region content to a buffer
; kill-some-buffers : interactively kill buffers
; electric-buffer-list : interactive buffer list
; toggle-truncate-lines : do not split lines over visual lines
; visual-line-mode : split lines by words
; viper-mode : vi compatibility mode

== Setting Key Bindings ==

{{Details|Key Bindings}}

Emacs has a global keymap which maps between keys and commands. Each major mode can define, re-define or un-define its own key bindings, creating a local keymap (e.g., c-mode). Each minor mode can do so too (e.g., flymake). Each portion of text can also do so (e.g., tables).

=== Some prefix keys ===

; {{Keys|C-x}} : command prefix key
; {{Keys|M-}} : command prefix key
; {{Keys|C-c}} : mode specific prefix key
; {{Keys|C-h}} : help prefix key

=== Commands to bind keys ===

; global-set-key ''k'' ''com'' : bind key ''k'' to ''com'' globally
; local-set-key ''k'' ''com'' : bind key ''k'' to ''com'' locally (major mode)

=== Notes ===

* Menu and mouse key bindings can also be set.

== Storing Key Bindings ==

In the Emacs ''init'' file, you can either set global key bindings or ''hook'' local key bindings to mode hooks (i.e., callbacks, slots).

; global-set-key : adds a binding to the global map
; local-set-key : adds a binding to the local (major mode) map
; kbd : converts a string to a key sequence

=== Examples ===

==== Global key binding ====

<source lang="lisp">
(global-set-key (kbd 'C-c d') 'duplicate-line)
(global-set-key (kbd 'C-c d') (kbd 'C-a C-@ C-e M-w RET C-y'))
(global-set-key (kbd 'C-c d') '\C-a\C- \C-n\M-w\C-y')
</source>

==== Local key binding ====

<source lang="lisp">
(add-hook 'LaTeX-mode-hook (lambda () (local-set-key (kbd 'C-c n') 'forward-paragraph)))
</source>

== The Emacs Help System ==

Emacs has a handy help system for quick lookup of various features, topics, functions and key bindings.

; {{Keys|C-h ?}} : show the help system shortcuts
; {{Keys|C-h ''key''}} : run help system with shortcut ''key''

=== Some useful help keys ===

; {{Keys|C-h a}} : show apropos page about a keyword
; {{Keys|C-h k ''keybind''}} : show help for function bound to ''keybind''
; {{Keys|C-h b}} : show all key bindings
; {{Keys|C-h f}} : show documentation for function
; {{Keys|C-h m}} : show documentation for current modes
; {{Keys|C-h v}} : show documentation for variable
; {{Keys|C-h w}} : show what keys a command is bound to
; {{Keys|C-h t}} : start the emacs tutorial
; {{Keys|''prefix'' C-h}} : show all key binds starting with ''prefix''

== Modes ==

Modes are used to define the type of data being edited in buffers, or what Emacs calls “the language”.

Every buffer has exactly one [[Major mode|major mode]] which defines its language (C, Java, English, IRC, etc...) and provides basic elements like syntax highlighting and (re)defines functions and their key bindings for relevant actions (e.g., comments).

Each buffer can have zero or more [[Minor mode|minor modes]] enabled which provide non-specific functionality such as spell checking or line wrapping (i.e., mode independent).

== Mode: ediff ==

ediff (emacs-diff) is a mode for Emacs where you can view and merge differences between two or three buffers.

; ediff : select files to view their differences
; ediff-buffers : select buffers to view their differences

=== In ediff-mode ===

; | : switch between horizontal/vertical view
; ? : view ediff help
; p : view previous difference
; n : view next difference
; a : set buffer b’s area to what’s in a’s
; b : set buffer a’s area to what’s in b’s
; q : quit ediff session

== Mode: Spell Checking ==

{{Details|Spell check}}

; {{Keys|M-$}} : check spelling at word or active region
; ispell : check active region or buffer, during which pressing '''i''' will accept the current word and insert it into the user's dictionary, pressing '''?''' will show help and pressing '''RET''' will end the current '''ispell''' session.
; {{Keys|ESC TAB}} : complete current word from dictionary
; flyspell-mode : enable “on the fly” spell checking
; flyspell-prog-mode : spell check comments and strings (programming mode)

== References ==

* Emacs Wiki: http://emacswiki.org/
* Emacs Docs: https://www.gnu.org/software/emacs/manual/html_node/emacs/index.html
* Emacs Help

[[Category:Tutorial]]

Talk:Quick Tutorial

2012-04-20T20:18:59Z

Francesco: /* Internal Links */

== Internal Links ==
This page is getting really Nice. It would be good if we have more internal links to other pages. So people reading this page will have a chance to read/learn more about individual features [[User:Kindahero]] 17:05, 20 April 2012 (EEST)
: I was thinking exactly the same thing :-) [[User:Bozhidar|Bozhidar]]
: +1. I started adding internal links and created [[Template:Details]] to format links to detailed sections (I more or less copied it from Wikipedia) -- [[User:Francesco|Francesco]] 23:18, 20 April 2012 (EEST)

Quick Tutorial

2012-04-20T20:15:51Z

Francesco: added links to other articles

This reference-like tutorial is aimed at Emacs beginners and probably others too. If you know how to do some basic editing and navigation in Emacs and want to quickly go through more of its capabilities, then this tutorial is for you. If you are looking for the semantics or key-bindings of a specific feature, this tutorial aims to be for you since it is a subset of the online Emacs documentation. If you are giving an introductory presentation about Emacs, this tutorial might help you.

== Description and History ==

* Emacs is an extensible, customizable, self-documenting, real-time display text editor.
* Originally, a set of editing macros for the TECO editor.
* GNU Emacs was developed by R. Stallman and G. Steele.
* Technically, GNU Emacs is an elisp interpreter with text editing extensions.
* GNU Emacs contains thousands of commands and allows the user to combine them into elisp procedures (called macros) to automate work.
* Commands are, themselves, elisp procedures and the GNU Emacs configuration '''init''' file is an elisp program.

== Technical Description ==

; Extensible : The user can define, un-define and redefine commands as well as re-use available commands into macros.
; Customizable : The user can change properties of emacs elements including the key-bindings and the display.
; Self-documenting : All defined commands and macros get automatic preliminary documentation (bound keys and parameters).

== Why Emacs? ==

* Easily programmable
* Kill ring
* Rectangular editing
* Registers
* Command repetition
* Macros and Lisp procedures
* Modes
* Init file
* Remote files
* Shell, Terminal Emulator, IRC, Email, News, File Manager, Process Manager, Project Manager, Tetris, Doctor and many others.

== Terminology and Structure ==

{{details|Emacs Terminology}}

; Buffer : A container for data (text, completions)
; Point : The current position in the buffer (cursor)
; Window : A visual container for a buffer
; Frame : A visual container for one or more windows
; Kill : The equivalent of cutting
; Yank : The equivalent of copying
; Kill Ring : A circular clipboard (very handy)
; Mark : The coordinates of a selection
; Region : The text inside a mark
; Modeline : A status line
; Minibuffer : A small buffer for commands and arguments
; Mode : The current type of data being edited

== Modeline ==

The Modeline is used to report different pieces of information.

<pre>-cs:ch-fr buf pos line (major minor)-----</pre>

; cs : Character set (or coding system)
; : : Newline mode
; ch : File modification status
; - or @ : File is local or remote
; fr : Frame name on text terminals
; buf : Buffer/file name
; pos : Point/cursor position
; line : Current line and column number
; modes (major minor) : Currently loaded major and minor modes

== Keybind Terms and Minibuffer ==

Emacs has some different naming of command/control keys (probably coming from the old days).

; M : Meta key, Alt or ESC
; C : Control key
; S : Shift key
; {{Keys|M-a}} : Press '''a''' while holding the meta key
; {{Keys|C-M-a}} : Press '''a''' while holding the control and meta keys
; {{Keys|C-a b}} : Press '''a''' while holding the control key then press '''b'''
; {{Keys|C-a C-b}} : Press '''a''' and '''b''' both while holding the control key
; {{Keys|C-a M-b}} : Press '''a''' with control then '''b''' with meta

The Minibuffer is used to input commands, arguments and setting different modes (which some of are bound to keys or menu actions).

; {{Keys|M-x}} : Execute a command by name

== Basic Usage ==

=== Loading ===

; <pre>$ emacs # opens Emacs at the scratch buffer</pre>
; <pre>$ emacs [file1] [file2] ... # opens Emacs in split-window mode</pre>
; {{Keys|C-x C-f}} ''filename'' : loads a new buffer from ''filename''

=== Saving ===

; {{Keys|C-x C-s}} : saves the current buffer
; {{Keys|C-x C-w}} ''filename'' : saves the current buffer as ''filename''

=== Other ===

; {{Keys|C-x C-c}} : quits emacs
; {{Keys|C-g C-g}} : cancels key-sequence

== Windows ==

Windows are used to display buffer contents. Windows can be split and resized inside an Emacs frame. The minibuffer has its own window.

; {{Keys|C-x 2}} : open a window vertically
; {{Keys|C-x 3}} : open a window horizontally
; {{Keys|C-x 0}} : close the current window
; {{Keys|C-x 1}} : close all other windows
; ESC ESC ESC : close all other windows
; {{Keys|C-x o}} : move to another window
; {{Keys|C-x ^}} : increase window size vertically
; {{Keys|C-x } }} : increase window size horizontally
; {{Keys|C-x {}} : decrease window size horizontally
; {{Keys|C-x -}} : shrink window to buffer size
; {{Keys|C-x +}} : make all windows equal in size

== Navigation and Movement ==

=== Word ===

; {{Keys|C-←}} : moves one word backwards
; {{Keys|C-→}} : moves one word forward

=== Line ===

; {{Keys|C-a}} : goes to beginning of the line (Home)
; {{Keys|C-e}} : goes to end of the line (End)
; {{Keys|M-a}} : goes to beginning of the sentence
; {{Keys|M-e}} : goes to end of the sentence
; {{Keys|M-g g}} : goes to given line by number
; {{Keys|M-m}} : moves point to the first non-whitespace character in this line

=== Paragraph ===

; {{Keys|C-↑}} : moves up one paragraph
; {{Keys|C-↓}} : moves down one paragraph

=== Window ===
; {{Keys|M-0 M-r}} : moves to the top of window
; {{Keys|M-r}} : moves to the middle of window
; {{Keys|M-- M-r}} : moves to the bottom of window

=== Buffer ===

; {{Keys|C-x [}} : moves to the beginning of the buffer
; {{Keys|C-x ]}} : moves to the end of the buffer
; {{Keys|C-l}} : moves the buffer to position point
; {{Keys|C-x b}} : switches to another buffer by name
; {{Keys|C-x}} : switches to previous or next buffer
; {{Keys|C-x k}} : kills the current buffer

== Editing ==

=== Character ===

; {{Keys|C-d}} : deletes next character
; {{Keys|C-t}} : transposes current character with previous one
; {{Keys|C-q TAB}} : inserts a TAB verbatim

=== Word ===

; {{Keys|M-d}} : kills the next word
; {{Keys|M-- M-d}} : kills to the previous word
; {{Keys|M-/}} : expands current word
; {{Keys|M-/ SPC M-/}} : expands current word and grabs next one
; {{Keys|M-C-/}} : completes current word
; {{Keys|M-t}} : transposes current word with next one
; {{Keys|M-- M-t}} : transposes current word with previous one
; {{Keys|M-c}} : capitalizes next word
; {{Keys|M-- M-c}} : capitalizes previous word
; {{Keys|M-l}} : lowercase next word
; {{Keys|M-- M-l}} : lowercase previous word
; {{Keys|M-u}} : uppercase next word
; {{Keys|M-- M-u}} : uppercase previous word

=== Line ===

; {{Keys|M-o M-s}} : center a line
; {{Keys|C-S-BACKSPC}} : kills current line
; {{Keys|C-k}} : kills from point to EOL
; {{Keys|M-u C-k}} : kills to the previous line
; {{Keys|C-a C-k}} : goes to BOL then kills to EOL
; {{Keys|TAB}} : indents line depending on current mode
; {{Keys|C-o}} : breaks line before/after point
; {{Keys|C-x C-t}} : transpose current line with previous one
; {{Keys|M-0 C-x}} C-t : transpose current line with one at mark
; delete-matching-lines : delete lines matching a regexp

== Prefix Arguments and Command Repetition ==

Passing numerical arguments to commands can alter their behavior (e.g., repetition or inversion). Passing an argument can be done before M-x or key bindings.

; {{Keys|M-''n'' ''com''}} : run ''com'' with prefix arg ''n''
; {{Keys|M-- ''com''}} : run ''com'' with negative prefix arg
; {{Keys|C-u ''n'' ''com''}} : run ''com'' with prefix arg ''n''
; {{Keys|C-u ''com''}} : run ''com'' with prefix arg 4 (the default)
; {{Keys|C-u C-u ''com''}} : run ''com'' with prefix arg 16 (four times the four times the default)
; {{Keys|C-u C-u ''com''}} : run ''com'' with prefix arg 64 (four times the four times the four times the default)
; {{Keys|C-u}} : also terminates the prefix argument
; {{Keys|C-x [z]+}} : repeats the previous z''th'' command (including its args)
; {{Keys|C-x ESC ESC}} : repeats last command that used the minibuffer

=== Examples ===

; {{Keys|C-u 5 0 C-k}} : will kill 50 lines
; {{Keys|C-u 5 C-u 0}} : will insert 5 zeros

== Search and Replace ==

=== Incremental search ===

{{Details|Incremental Search}}

; {{Keys|C-s keyword}} : search forward
; {{Keys|C-r keyword}} : search backward

=== Non-incremental search ===

; {{Keys|C-s RET keyword}} : search forward
; {{Keys|C-r RET keyword}} : search backward

=== Regular Expression Search ===

{{Details|Regexp Search}}

; {{Keys|C-M-s expression}} : search regexp forward
; {{Keys|C-M-r expression}} : search regexp backward

=== Notes ===

* '''ESC''' will cancel and go to original point. '''RET''' will end at the current point.
* Searches are case-insensitive unless an uppercase letter is found in the search string.
* While searching, {{Keys|C-w}} will increment the search term with the current word.

=== Unconditional Replace ===

; replace-string : replaces a string with another
; replace-regexp : replaces a regexp match with a string

=== Query Replace (Conditional Replace) ===

; {{Keys|M-%}} : conditional replacement of a string
; query-replace-regexp : conditional replacement of a regular expression

=== Notes ===

* Replaces are case-insensitive unless an uppercase letter is found in the match string.
* Replaces work from position to end of buffer unless a mark is active.
* After a replace, the position will be at the end of the last match. {{Keys|C-u C-SPC}} to go back to the position before the replace started.
* During a query replace, '''SPC''' will apply a replace and '''DEL''' will skip.

== Undo and Redo ==

In Emacs, there is no special redo function. Instead, there is only an undo function and redo can be achieved by ''undo-ing'' an undo.

; {{Keys|C-/}} : undo a single change
; {{Keys|C-g}} : break the chain of undos

=== Notes ===

* If a mark is active, undo will only affect the marked region.

== Regions ==

Emacs uses the mark and point to denote a [[Region|region]] (i.e., a selection).

; {{Keys|C-SPC}} : creates a region (marks area)
; {{Keys|C-x C-x}} : swaps mark and point in a region
; {{Keys|C-u C-x C-x}} : swaps mark and point without region
; {{Keys|C-x h}} : marks the entire buffer
; {{Keys|M-h}} : marks the paragraph around the point
; {{Keys|TAB}} : indents the current region
; {{Keys|M-@}} : incrementally mark next word

=== Kill, Yank and Paste Regions ===

; {{Keys|C-w}} : kills the currently selected region
; {{Keys|M-w}} : copies the currently selected region
; {{Keys|C-y}} ({{Keys|M-y}})* : yanks and cycles from the kill ring

=== Notes ===

* Yank is the copy command in vi and the paste command in emacs.

== Rectangles ==

[[Rectangles]] are marked regions between the columns of the point and the mark. Applying operations on rectangles is some sort of vertical editing.

; {{Keys|C-x r k}} : kill the rectangle
; {{Keys|C-x r d}} : delete the rectangle
; {{Keys|C-x r y}} : yank the last killed rectangle
; {{Keys|C-x r o}} : push text to fill rectangle with spaces (open)
; {{Keys|C-x r c}} : replace rectangle text with spaces (clear)
; {{Keys|C-x r t}} : replace each line in rectangle with text

== Registers ==

[[Registers]] are places where you can store anything: text, position, rectangle, configuration, filename, etc... Registers are named with single character symbols: ''a'', ''A'' and ''3'' are three different registers.

; view-register : view the contents of a register
; {{Keys|C-x r SPC ''r''}} : record current point position in register ''r''
; {{Keys|C-x r j ''r''}} : jump to position in register ''r''
; {{Keys|C-x r s ''r''}} : save region to register ''r''
; {{Keys|C-u C-x r s ''r''}} : kill region to register ''r''
; {{Keys|C-x r i ''r''}} : insert text from register ''r''
; append-to-register : append region to register
; prepend-to-register : prepend region to register
; {{Keys|C-x r r ''r''}} : save rectangle into register ''r''

== Bookmarks ==

[[Bookmarks]] are like registers but persistent. They can also be named.

; {{Keys|C-x r m ''foo''}} : bookmark file and point to ''foo''
; {{Keys|C-x r b ''foo''}} : jump to bookmark called ''foo''
; {{Keys|C-x r l}} : list all bookmarks
; bookmark-save : save all bookmarks
; bookmark-delete : delete a bookmark

== Macros ==

[[Keyboard macros]] are user defined commands using the Emacs command language. A user can ''record'' and ''replay'' a macro, useful for simple repeatable tasks. More complex tasks (e.g., conditions, loops) must be implemented in ''elisp''. Macros are recorded in a macro ring.

; {{Keys|F3}} : start macro definition or insert counter
; {{Keys|C-x (}} : start macro definition only
; {{Keys|F4}} : end macro definition or call macro
; {{Keys|C-x e}} : end macro definition and call macro
; {{Keys|C-x )}} : end macro definition only
; {{Keys|C-u C-u F3}} : append commands to last macro
; {{Keys|C-u F3}} : re-run last macro then append commands to it
; {{Keys|C-x C-k r}} : run macro on region
; {{Keys|C-x C-k C-n}} : rotate to select the next macro in the ring
; {{Keys|C-x C-k C-p}} : rotate to select the previous macro in the ring

=== Macro Counters ===

Every macro definition can have a counter to insert into the buffer.

; {{Keys|F3}} : inside a macro definition, inserts the counter
; {{Keys|C-x C-k C-i}} : outside a macro definition, inserts the counter
; {{Keys|C-x C-k C-c}} : set the macro counter value
; {{Keys|C-x C-k C-f}} : set the macro counter format

=== Saving Macros ===

Macros can be named and saved.

; {{Keys|C-x C-k n}} : name the most recently defined macro
; {{Keys|C-x C-k b}} : keybind the most recently defined macro
; insert-kbd-macro : insert macro into buffer as elisp code

=== Notes ===

* It is best to use the reserved key bindings {{Keys|C-x C-k [a-zA-Z0-9]}} as to not cause problems with other bindings. {{Keys|C-x C-k b 4}} will define {{Keys|C-x C-k 4}} as a binding.

== Alignment ==

Emacs contains alignment commands. Sometimes those depend on the current mode (i.e., the language).

; align : aligns depending on mode
; align-regexp : aligns using a regular expression
; {{Keys|C-u align-regexp}} : aligns using a regular expression helper
; align-current : aligns current paragraph depending on mode

== Sorting ==

When sorting, prefixing with {{Keys|C-u}} sorts in descending order.

; sort-lines : sort region by lines
; sort-paragraphs : sort region by paragraphs
; {{Keys|C-u ''n'' sort-fields}} : sort lines in region by n''th'' field
; {{Keys|C-u -''n'' sort-fields}} : sort lines in region by n''th'' field from right
; sort-numeric-fields : interpret field as number and not text
; sort-columns : sort by column specified by marked region
; reverse-region : reverses current region

== Tables ==

Emacs has support for creating and editing text-based tables by keeping track of their properties (e.g., position, size) in the buffer. When a buffer is saved to file, those properties are lost.

; table-insert : interactively insert a table into buffer
; table-recognize : detect properties of all tables in the buffer
; table-unrecognize : remove special table properties
; table-recognize-region : detect properties of tables in region
; table-unrecognize-region : forget properties of tables in region
; table-recognize-table : detect properties of table at point
; table-unrecognize-table : remove properties of table at point

=== Cell resizing ===

; {{Keys|C-u ''n'' C->}} : widen cell at point by ''n'' characters
; {{Keys|C-u ''n'' C-<}} : narrow cell at point by ''n'' characters
; {{Keys|C-u ''n'' C-｝}} : heighten cell at point by ''n'' lines
; {{Keys|C-u ''n'' C-｛}} : shorten cell at point by ''n'' lines

=== Cell movement ===

; {{Keys|TAB}} : move to cell on right
; {{Keys|S-TAB}} : move to cell on left

=== Cell merging and splitting ===

; {{Keys|C-c C-c *}} : interactively merge two cells
; {{Keys|C-+}} : split cell horizontally
; {{Keys|C--}} : split cell vertically

=== Rows and Columns ===

; {{Keys|C-u ''n'' table-insert-row}} : insert ''n'' rows
; {{Keys|C-u ''n'' table-delete-row}} : delete ''n'' rows
; {{Keys|C-u ''n'' table-insert-column}} : insert ''n'' columns
; {{Keys|C-u ''n'' table-delete-column}} : delete ''n'' columns

=== Other ===

; {{Keys|C-:}} : interactively justify cell, column or row text
; {{Keys|C-!}} : toggle table fixed width mode
; table-generate-source : table code in Latex, HTML or Cals

== Goodies ==

; {{Keys|C-x TAB}} : force an indentation on a region
; {{Keys|M-q}} : indents and breaks paragraph into multiple lines
; {{Keys|M-;}} : comments a region or adds comment to line
; {{Keys|M-(}} : inserts a new lisp function (parenthesis)
; {{Keys|M-)}} : checks balanced parenthesis and opens line
; {{Keys|C-x i}} : inserts file contents at point position
; {{Keys|M-!}} : run shell command
; {{Keys|C-u M-!}} : run shell command and insert output
; {{Keys|M-|}} : run shell command on marked region
; {{Keys|C-u M-|}} : run shell command on and replace marked region
; insert-buffer : inserts buffer contents at point position
; copy-to-buffer : copy region content to a buffer
; kill-some-buffers : interactively kill buffers
; electric-buffer-list : interactive buffer list
; toggle-truncate-lines : do not split lines over visual lines
; visual-line-mode : split lines by words
; viper-mode : vi compatibility mode

== Setting Key Bindings ==

{{Details|Key Bindings}}

Emacs has a global keymap which maps between keys and commands. Each major mode can define, re-define or un-define its own key bindings, creating a local keymap (e.g., c-mode). Each minor mode can do so too (e.g., flymake). Each portion of text can also do so (e.g., tables).

=== Some prefix keys ===

; {{Keys|C-x}} : command prefix key
; {{Keys|M-}} : command prefix key
; {{Keys|C-c}} : mode specific prefix key
; {{Keys|C-h}} : help prefix key

=== Commands to bind keys ===

; global-set-key ''k'' ''com'' : bind key ''k'' to ''com'' globally
; local-set-key ''k'' ''com'' : bind key ''k'' to ''com'' locally (major mode)

=== Notes ===

* Menu and mouse key bindings can also be set.

== Storing Key Bindings ==

In the Emacs ''init'' file, you can either set global key bindings or ''hook'' local key bindings to mode hooks (i.e., callbacks, slots).

; global-set-key : adds a binding to the global map
; local-set-key : adds a binding to the local (major mode) map
; kbd : converts a string to a key sequence

=== Examples ===

==== Global key binding ====

<source lang="lisp">
(global-set-key (kbd 'C-c d') 'duplicate-line)
(global-set-key (kbd 'C-c d') (kbd 'C-a C-@ C-e M-w RET C-y'))
(global-set-key (kbd 'C-c d') '\C-a\C- \C-n\M-w\C-y')
</source>

==== Local key binding ====

<source lang="lisp">
(add-hook 'LaTeX-mode-hook (lambda () (local-set-key (kbd 'C-c n') 'forward-paragraph)))
</source>

== The Emacs Help System ==

Emacs has a handy help system for quick lookup of various features, topics, functions and key bindings.

; {{Keys|C-h ?}} : show the help system shortcuts
; {{Keys|C-h ''key''}} : run help system with shortcut ''key''

=== Some useful help keys ===

; {{Keys|C-h a}} : show apropos page about a keyword
; {{Keys|C-h k ''keybind''}} : show help for function bound to ''keybind''
; {{Keys|C-h b}} : show all key bindings
; {{Keys|C-h f}} : show documentation for function
; {{Keys|C-h m}} : show documentation for current modes
; {{Keys|C-h v}} : show documentation for variable
; {{Keys|C-h w}} : show what keys a command is bound to
; {{Keys|C-h t}} : start the emacs tutorial
; {{Keys|''prefix'' C-h}} : show all key binds starting with ''prefix''

== Modes ==

Modes are used to define the type of data being edited in buffers, or what Emacs calls “the language”.

Every buffer has exactly one [[Major mode|major mode]] which defines its language (C, Java, English, IRC, etc...) and provides basic elements like syntax highlighting and (re)defines functions and their key bindings for relevant actions (e.g., comments).

Each buffer can have zero or more [[Minor mode|minor modes]] enabled which provide non-specific functionality such as spell checking or line wrapping (i.e., mode independent).

== Mode: ediff ==

ediff (emacs-diff) is a mode for Emacs where you can view and merge differences between two or three buffers.

; ediff : select files to view their differences
; ediff-buffers : select buffers to view their differences

=== In ediff-mode ===

; | : switch between horizontal/vertical view
; ? : view ediff help
; p : view previous difference
; n : view next difference
; a : set buffer b’s area to what’s in a’s
; b : set buffer a’s area to what’s in b’s
; q : quit ediff session

== Mode: Spell Checking ==

{{Details|Spell check}}

; {{Keys|M-$}} : check spelling at word or active region
; ispell : check active region or buffer, during which pressing '''i''' will accept the current word and insert it into the user's dictionary, pressing '''?''' will show help and pressing '''RET''' will end the current '''ispell''' session.
; {{Keys|ESC TAB}} : complete current word from dictionary
; flyspell-mode : enable “on the fly” spell checking
; flyspell-prog-mode : spell check comments and strings (programming mode)

== References ==

* Emacs Wiki: http://emacswiki.org/
* Emacs Docs: https://www.gnu.org/software/emacs/manual/html_node/emacs/index.html
* Emacs Help

[[Category:Tutorial]]

Template:Details

2012-04-20T20:02:33Z

Francesco: Template for detailed section links

''For more details on {{{2|this topic}}}, see [[{{{1}}}]].''

Rectangles

2012-04-20T19:50:07Z

Francesco: fixed typo

Rectangle commands operate on rectangular areas of the text: all the characters between a certain pair of columns, in a certain range of lines. Emacs has commands to kill rectangles, yank killed rectangles, clear them out, fill them with blanks or text, or delete them. Rectangle commands are useful with text in multicolumn formats, and for changing text into or out of such formats.

When you must specify a rectangle for a command to work on, you do it by putting the mark at one corner and point at the opposite corner. The rectangle thus specified is called the region-rectangle because you control it in much the same way as the region is controlled. But remember that a given combination of point and mark values can be interpreted either as a region or as a rectangle, depending on the command that uses them.

If point and the mark are in the same column, the rectangle they delimit is empty. If they are in the same line, the rectangle is one line high. This asymmetry between lines and columns comes about because point (and likewise the mark) is between two columns, but within a line.

== Command of rectangles ==

* {{Keys|C-x r k}} or {{Command|kill-rectangle}}
Kill the text of the region-rectangle, saving its contents as the “last killed rectangle”.
* {{Keys|C-x r d}} or {{Command|delete-rectangle}}
Delete the text of the region-rectangle.
* {{Keys|C-x r y}} or {{Command|yank-rectangle}}
Yank the last killed rectangle with its upper left corner at point.
* {{Keys|C-x r o}} or {{Command|open-rectangle}}
Insert blank space to fill the space of the region-rectangle. This pushes the previous contents of the region-rectangle rightward.
* {{Keys|C-x r c}} or {{Command|clear-rectangle}}
Clear the region-rectangle by replacing all of its contents with spaces.
* {{Command|delete-whitespace-rectangle}}
Delete whitespace in each of the lines on the specified rectangle, starting from the left edge column of the rectangle.
* {{Keys|C-x r t string RET}} or {{Command|string-rectangle}}
Replace rectangle contents with string on each line.
* {{Command|string-insert-rectangle RET string RET}}
Insert string on each line of the rectangle.

[[Category:Text Editing]]

Template:NewPage

2012-04-05T16:05:00Z

Francesco: mention of builtin/3rd party categories

'''{{{1}}}''' is a wonderful mode which does wonderful things.









== Basic setup ==

Install these third party libraries or read this section before proceeding.

== Helpful keybindings ==

; {{Keys|C-x C-c}}
: Quit Emacs.

; {{CommandKeys|C-x C-s|save-buffer}}
: Save buffer.


== Common Customization ==


=== Customization 1 ===
<source lang="lisp">
(message "This stuff will go in your .emacs")
</source>



== [[GNU/Linux]] ==




== [[OS X]] ==




== [[Windows]] ==




== [[Emacs-24]] ==





== [[Emacs-23]] ==

Emacs-23 is not as great as Emacs-24. You will have these problems and you can workaround it this way.



== Recommended Reading ==

* [[Internal Link1]]
* [[Internal Link2]]



== Project Pages ==
* [http://bazaar.canonical.com/en/ Bazaar]
* [http://doc.bazaar-vcs.org/bzr.dev/en/user-guide/index.html Bzr Users Guide]



== Tutorial Pages ==
;[http://wiki.bazaar.canonical.com/EmacsTips Emacs as commit message editor]
:Tips for setting up Emacs as Bazaar commit editor.




[[Category:TestCategory1]][[Category:TestCategory2]]


<noinclude>[[Category:Templates]]</noinclude>

Expand region

2012-04-05T15:27:41Z

Francesco: not part of emacs

{{Package
|name=expand-region
|description=Emacs extension to increase selected region by semantic units.
|author=Magnar Sveen
|maintainer=Magnar Sveen
|source=https://github.com/magnars/expand-region.el
|in_emacs=No
}}

'''Expand region''' increases the selected region by semantic units. Just keep pressing the key until it selects what you want.

An example:

<source lang="lisp">
(setq alphabet-start "abc def")
</source>

With the cursor at the '''c''', it starts by marking the entire word '''abc''', then expand to the contents of the quotes '''abc def''', then to the entire quote '''"abc def"''', then to the contents of the sexp '''setq alphabet-start "abc def"''' and finally to the entire sexp.

== Basic setup ==

<source lang="lisp">
(require 'expand-region)
(global-set-key (kbd "C-=") 'er/expand-region)
</source>

== Helpful keybindings ==

== Common Customization ==

=== Replacing the Region ===

{{Command|delete-selection-mode}} is sometimes used in conjunction with [[Expand region]]. [[Delete selection]] is a [[minor mode]] that allows you to delete and replace the contents of the current region by simply typing over it.

== See Also ==

== Project Pages ==

* [https://github.com/magnars/expand-region GitHub Repo]

== Tutorial Pages ==

*[http://emacsrocks.com/e09.html Screencast]

[[Category:Project Management]][[Category:Convenience]][[Category:Third Party Package]]

Category talk:Native Package

2012-04-05T14:32:57Z

Francesco: /* Native vs Builtin */

Itsn't Built-in package a better term than native? I've never heard anyone using the term native for packages coming with Emacs, but I've seen built-in used a lot (even by package.el) [[User:Bozhidar|Bozhidar]]
:+1! Is there any mechanism to rename a category? [[User:GregLucas|GregLucas]] 17:25, 5 April 2012 (EEST)

: may be "built-in" is better. I don't have any idea on this, I was just adding that since it was there before. -- [[User:Kindahero|Kindahero]] 17:30, 5 April 2012 (EEST)

: I also think "built-in" is the most widely used terminology. [[User:Francesco|Francesco]] 17:32, 5 April 2012 (EEST)

Woman

2012-04-05T14:29:01Z

Francesco: Created page with "{{Package |name=WoMan |description=Man page lookup integration into Emacs |author=F. J. Wright |maintainer= |source=http://centaur.maths.qmw.ac.uk/Emacs/WoMan/ |in_emacs=yes, ..."

{{Package
|name=WoMan
|description=Man page lookup integration into Emacs
|author=F. J. Wright
|maintainer=
|source=http://centaur.maths.qmw.ac.uk/Emacs/WoMan/
|in_emacs=yes, since Emacs 21
}}
'''Woman''' ('''W'''ith'''O'''ut '''Man''') is a program to browse Unix manual pages without calling the external <tt>man</tt> utility. This presents both advantages and disadvantages over the classical [[man]] package, which uses the external <tt>man</tt> tool to format manpages:

* ''[advantage]'' it is entirely integrated in Emacs and does not require external dependencies (which is useful on non-UNIX platforms where these dependencies might not be installed);
* ''[disadvantage]'' it does not provide a complete support of the <tt>roff</tt> language; complex manpages might not be fully rendered.

== Basic usage ==

WoMan is integrated in Emacs should work out of the box. Simply type e.g. {{Command|woman RET bash RET}} to see the <tt>bash</tt> manual page. If the topic name you enter is available in multiple sections, you'll have to choose the correct one interactively afterwards.

== Helpful keybindings ==

Manpages are presented using a [[major mode]] essentially similar to [[man]], with the same key bindings:

; {{Keys|g}}
: Jump to a specific section within the manpage.

; {{Keys|n}} and {{Keys|p}}
: Jump to the next/previous manpage section.

; {{Keys|m}} or {{Keys|w}}
: Open another manpage.

; {{Keys|q}} and {{Keys|k}}
: Quit the manpage, and bury/kill the buffer.

== Recommended Reading ==

* [[man]]

== Project Pages ==
* [http://centaur.maths.qmw.ac.uk/Emacs/WoMan/ WoMan web pages]

== External documentation ==
* {{Manual|woman|Introduction|Introduction}}




[[Category:Documentation]]

User:Francesco

2012-04-05T06:50:47Z

Francesco:

Man

2012-04-05T06:45:56Z

Francesco: Created page with "{{Package |name=man |description=Man page lookup integration into Emacs |author= |maintainer= |source= |in_emacs=yes }} {{Command|man}} allows you to browse the manual pages..."

{{Package
|name=man
|description=Man page lookup integration into Emacs
|author=
|maintainer=
|source=
|in_emacs=yes
}}

{{Command|man}} allows you to browse the manual pages installed on your system. It uses the external <tt>man</tt> tool to format the page and present it to you in a {{Buffer|*Man topic*}} buffer using a specific major mode facilitating navigation.

== Basic usage ==

Man is part of Emacs and should work out of the box. You just need to enter the name of the man page: {{Command|man RET bash RET}}. To read a man page from a specific section, you can specify it by wrapping it in parentheses after the topic name: {{Command|man RET chmod(2) RET}}.

== Helpful keybindings ==

; {{Keys|g}}
: Jump to a specific section within the manpage.

; {{Keys|n}} and {{Keys|p}}
: Jump to the next/previous manpage section.

; {{Keys|m}}
: Open another manpage.

; {{Keys|q}} and {{Keys|k}}
: quit the manpage, and bury/kill the buffer.

== [[Windows]] ==

Since the external utility <tt>man</tt> is generally not installed on MS Windows platforms, Windows users might prefer using [[woman]], which does not need any external tool.

== Recommended Reading ==

* [[woman]]

== External documentation ==
* {{Manual|emacs|Man-Page|Man Page Lookup}}

[[Category:Documentation]]

Operating System

2012-04-04T07:36:10Z

Francesco: setup redirect

#REDIRECT: [[Category:Operating System]]

GNU/Linux

2012-04-04T07:35:24Z

Francesco: removed category OS since GNU/Linux already is a subcategory

GNU/Linux is [[Unix]] like [[Operating System]].

For details about installing Emacs on GNU/linux, refer [[Installing Emacs on GNU/Linux]]

[[Category:GNU/Linux]]

Minor mode

2012-04-04T07:33:30Z

Francesco: setup redirect

#REDIRECT: [[Emacs Terminology#Minor mode]]

Vc

2012-04-04T07:31:53Z

Francesco: /* Helpful key bindings */ (see also diff-mode)

{{Package
|name=vc
|description=Version control front end for emacs
|author= several authors
|maintainer=[[Andre Spiegel]]
|source=http://git.savannah.gnu.org/cgit/emacs.git/tree/lisp/vc/
|in_emacs=yes
|Development status=active
}}

'''vc''' is a [[Version Control]] minor mode. This minor mode is
automatically activated whenever a file is opened which is under any
revision control system. It supports many different version control
systems including [[git]], [[bazaar]], [[CVS]] and [[SVN]] etc. It
gives a unique interface to Emacs irrespective of back end version control system in operation.

== Basic setup ==
No particular setup is needed for basic usage. Emacs checks for usage
of version control automatically when a file is being opened.

== Helpful key bindings ==

; {{CommandKeys|C-x v +|vc-update}}
: Update the current fileset's files to their tip revisions.
; {{CommandKeys|C-x v =|vc-diff}}
: Display diffs between file revisions in a buffer using [[diff-mode]].
; {{CommandKeys|C-x v g|vc-annotate}}
: Display the edit history of the current file.

== Common customizations ==

=== Automatically revert version-controlled buffers ===
Since version controlled files tend to be changed outside of Emacs, it might be useful to automatically activate [[auto-revert-mode]].

<source lang="lisp">
;; Activate `auto-revert-mode' for version-controlled files
(defadvice vc-find-file-hook (after auto-revert-mode-for-vc activate)
"vc-find-file-hook advice for activating `auto-revert-mode'"
(when vc-mode (auto-revert-mode 1)))
</source>

== See Also ==
:* [[Magit]]
:* [[diff]]
:* [[ediff]]

[[Category:Minor Mode]]
[[Category:Version Control]]
[[Category:Major Components of Emacs]]

Vc

2012-04-04T07:12:06Z

Francesco: Helpful keybindings + Common customization

{{Package
|name=vc
|description=Version control front end for emacs
|author= several authors
|maintainer=[[Andre Spiegel]]
|source=http://git.savannah.gnu.org/cgit/emacs.git/tree/lisp/vc/
|in_emacs=yes
|Development status=active
}}

'''vc''' is a [[Version Control]] minor mode. This minor mode is
automatically activated whenever a file is opened which is under any
revision control system. It supports many different version control
systems including [[git]], [[bazaar]], [[CVS]] and [[SVN]] etc. It
gives a unique interface to Emacs irrespective of back end version control system in operation.

== Basic setup ==
No particular setup is needed for basic usage. Emacs checks for usage
of version control automatically when a file is being opened.

== Helpful key bindings ==

; {{CommandKeys|C-x v +|vc-update}}
: Update the current fileset's files to their tip revisions.
; {{CommandKeys|C-x v =|vc-diff}}
: Display diffs between file revisions.
; {{CommandKeys|C-x v g|vc-annotate}}
: Display the edit history of the current file.

== Common customizations ==

=== Automatically revert version-controlled buffers ===
Since version controlled files tend to be changed outside of Emacs, it might be useful to automatically activate [[auto-revert-mode]].

<source lang="lisp">
;; Activate `auto-revert-mode' for version-controlled files
(defadvice vc-find-file-hook (after auto-revert-mode-for-vc activate)
"vc-find-file-hook advice for activating `auto-revert-mode'"
(when vc-mode (auto-revert-mode 1)))
</source>

== See Also ==
:* [[Magit]]
:* [[diff]]
:* [[ediff]]

[[Category:Minor Mode]]
[[Category:Version Control]]
[[Category:Major Components of Emacs]]

Emacs Lisp

2012-04-04T06:47:29Z

Francesco: fixed keys

{{Infobox major-mode
|title = Emacs Lisp
|library = lisp-mode
|command = emacs-lisp-mode
|builtin = yes
|auto activates = *.el, .emacs, _emacs
}}

'''Emacs Lisp''' is a dialect of the [[Lisp]] programming language used by GNU Emacs. Most of the editing functionality built into Emacs is written in Emacs Lisp, with the remainder being written in C (as is the Lisp interpreter itself). Users of Emacs commonly write Emacs Lisp code to customize and extend Emacs.

Emacs Lisp is also commonly referred to as "elisp" or "Elisp". Files containing Emacs Lisp code use the <tt>.el</tt> filename suffix; when [[byte-compile]]d, the same filename prefix is used but with the <tt>.elc</tt> filename suffix.

Emacs Lisp is a [https://hornbeck.wordpress.com/2009/07/05/lisp-1-vs-lisp-2/ Lisp-2], which means that a single identifier (in Lisp terminology, "symbol") can simultaneously exist as ("be bound to") both a function and a variable.

= Basic setup =

You can customize the way Emacs edits and displays this and all other [[:Category:Lisp|lisp languages]] with {{CustomizeGroup|lisp}}.

= Helpful keybindings =

; {{Keys|M-TAB}}
: Complete at point

; {{Keys|C-M-q}}
: Indent the [[S-expression]] following [[point and mark|point]]

; {{Keys|C-M-x}}
: Evaluate the <code>defun</code> at [[point and mark|point]]

= Common customizations =

== Outlining ==

For [[Org]]-style outlining, add the following snippet to your {{EmacsConfigFile}}.

<source lang="lisp">
;; Turn on outline minor mode
(add-hook 'emacs-lisp-mode-hook 'outline-minor-mode)

;; Add key bindings for Org-style outline cycling
(add-hook 'outline-minor-mode-hook
(lambda ()
(define-key outline-minor-mode-map [(control tab)] 'org-cycle)
(define-key outline-minor-mode-map [(shift tab)] 'org-global-cycle)))
</source>

Now visit any elisp file (say {{Command|find-library RET outline}}) and keep pressing {{Keys|S-TAB}} and see what happens. Experiment similarly with {{Keys|C-TAB}}.

== Indentation ==

Add the following snippet to your {{EmacsConfigFile}}, so that you don't have to indent deliberately. See {{Command|reindent-then-newline-and-indent}}.

<source lang="lisp">
(add-hook 'emacs-lisp-mode-hook
(lambda nil
(local-set-key [(return)] 'reindent-then-newline-and-indent)))
</source>

== Always keep parentheses balanced ==

See [[Skeleton#Keep some chars always balanced]]

== Scope ==
By default elisp uses [[dynamic scope]]. Since Emacs 24 [[lexical scope]] has been added. <br/>
To use lexical binding, an Emacs-lisp source file must set a file-variable {{Variable|lexical-binding}} to <tt>t</tt> in the file header, e.g., by using a first line like: <br/>

;;; -*- lexical-binding: t -*-

= External links =

* [http://www.gnu.org/software/emacs/manual/html_node/elisp/index.html Emacs Lisp manual]

[[Category:Lisp]]
[[Category:Programming]]
[[Category:Programming languages]]

TRAMP

2012-04-02T06:36:47Z

Francesco: completed infobox information

{{Package
|name=TRAMP
|description=Edit files on remote systems
|source=http://savannah.gnu.org/projects/tramp
|in_emacs=yes, since Emacs 22
}}

Emacs' TRAMP feature (Transparent Remote file Access, Multiple Protocol) is an extremely powerful tool for editing files that exist on remote systems, or require access using a different user account from your main Emacs session, or both.

Some of the things that TRAMP can do include:

* Editing files on a remote development server over SSH (e.g. <tt>/ssh:remote-user@remote.box:/path/to/my/file</tt>)
* Editing files on your local machine as root via sudo (e.g. <tt>/sudo::/etc/some/config/file</tt>)
* Editing files on a remote server as root via sudo over an SSH connection from another remote machine that exists within a DMZ (requires some configuration, see below)

TRAMP is included with Emacs and described in the manual.

== Multiple hops ==

To set up multiple hop connections you will need to do a little bit of configuration.

As an example, let's assume that you want to edit a file located at <tt>/etc/httpd/conf/httpd.conf</tt> as root on a remote server at dev.example.com. You have a regular user account <tt>chris</tt> on the development sever, but you need to use sudo to gain root access before editing the file.

Put the following into your configuration files:

<source lang="lisp">
;; Guard to ensure that TRAMP is available
(if (locate-library "tramp")
(eval-after-load "tramp"

;; The actual TRAMP configuration
'(add-to-list 'tramp-default-proxies-alist
'("\\`dev\\.example\\.com\\'"
"\\`chris\\'"
"/ssh:%h:"))))
</source>

After this is evaluated, Emacs knows that the hostname dev.example.com must be accessed over SSH by a user called chris.

If you now try to find <tt>/sudo:dev.example.com:/etc/httpd/conf/httpd.conf</tt> Emacs will automatically create the SSH connection first, prompting you for your password if necessary. Then it will prompt you for your sudo password. Once this is all done you will be able to modify the buffer as necessary. Saving the buffer will do what you expect: it will update the file on the remote server.

It is also possible to configure partial domains, for instance in case you need an SSH connection before modifying anything on <tt>*.example.com</tt>.

Hops can be chained, making this feature extremely powerful.

== A note for Windows users ==

TRAMP uses programs that are usually included with GNU/Linux systems under the hood. These are not usually available on a Windows system.

The <tt>plink</tt> method built into TRAMP can be used as a mostly drop-in replacement for SSH connections. It uses <tt>plink.exe</tt> from the [http://www.chiark.greenend.org.uk/~sgtatham/putty/ PuTTY suite of tools], which must be installed separately.

[[Category:Remote Edit]]

MuMaMo

2012-04-01T21:21:26Z

Francesco: setup redirect

#REDIRECT: [[NXhtml]]

Major Mode

2012-04-01T21:18:14Z

Francesco: Added mention of MuMaMo on the terminology page and setup redirect

#REDIRECT: [[Emacs Terminology#Major mode]]

Emacs Terminology

2012-04-01T21:16:37Z

Francesco: /* Major mode */ added mention of MuMaMo

== Buffer ==

When you use {{Keys|C-x C-f}} to invoke command find-file, Emacs opens the file you request, and puts its contents into
a buffer with the same name as the file. Instead of thinking that you are editing a file, think that you are editing
text in a buffer. When you save the buffer, the file is updated to reflect your edits.

Buffers can also contain text that doesn't come from a file. When you use {{Keys|C-x C-b}} to get a list of buffers,
that list is itself in a buffer, called <tt>*Buffer List*</tt>, and that buffer is not associated with any file.

By convention, buffers whose names start with an asterisk ('''`*'''') are not associated with files (but that doesn't
mean you can't save them in files). If they have unsaved changes when you exit Emacs, these buffers are killed without
your being asking for confirmation.

Buffers whose names start with a space are [[InvisibleBuffers|invisible]] to many operations. These are generally
internal buffers that you don't want to see. Their names normally don't appear in the buffer list or as
[[Completion|completion]] candidates when you switch buffers using {{Keys|C-x b}}.

Buffers are shown in [[#Window|windows]]. You can have more than one window showing the same buffer. {{Keys|C-x 2}}
splits the current window, creating two windows, both showing the same buffer.

You can read more about windows in the Emacs manual:
* {{Manual|emacs|Buffers|Buffers}}
* {{Manual|emacs|Windows|Windows}}

== Window ==

In Emacs terminology, a "window" is a container in which a [[#Buffer|buffer]] is displayed. This may be confusing at first; if so, think "pane" whenever you see "window" in an Emacs context until you get used to it.

A new Emacs [[#Frame|frame]] contains one window. This window can be split in to multiple windows using:
* {{CommandKeys|C-x 2|split-window-below}} - Split the window horizontally to create two stacked windows
* {{CommandKeys|C-x 3|split-window-right}} - Split the window vertically to create two side-by-side windows

You can use multiple windows to view different [[#Buffer|buffers]] (or different portions of the same [[#Buffer|buffer]]) at once.

You can read more about windows in the Emacs manual:
* {{Manual|emacs|Screen|Screen}}
* {{Manual|emacs|Windows|Windows}}

== Frame ==

In Emacs terminology, a "frame" is what most window managers (Windows, OSX, GNOME, KDE, etc.) would call a "window".

It will typically have a title bar and some buttons to iconify (minimize), maximize / restore, and close the frame. To
see an example, open up a second frame from your running Emacs instance with {{CommandKeys|C-x 5 2|make-frame-command}}. You can close frames with {{CommandKeys|C-x 5 0|delete-frame}}, though this
will not close the last frame that is open.

To be completely correct, frames can be created when Emacs is running in terminal mode too, not just in a windowing system. They don't provide the same visual cues but otherwise work the same.

You can read more about frames in the Emacs manual:
* {{Manual|emacs|Screen|Screen}}
* {{Manual|emacs|Frames|Frames}}

== Point ==

The active cursor shows the location at which editing commands will
take effect, which is called "point". Many Emacs commands move
point to different places in the buffer; for example, you can place
point by clicking mouse button 1 (normally the left button) at the
desired location.

If you use a block cursor, the cursor appears to be on a
character, but you should think of point as between two characters;
it points before the character that appears under the cursor. For
example, if your text looks like `frob' with the cursor over the `b',
then point is between the `o' and the `b'. If you insert the character
`!' at that position, the result is `fro!b', with point between the `!'
and the `b'. Thus, the cursor remains over the `b', as before.

Sometimes people speak of "the cursor" when they mean "point," or
speak of commands that move point as "cursor motion" commands.

You can read more about the point in the Emacs manual:
* {{Manual|emacs|Point|Point}}

== The Mark and the Region ==

Many Emacs commands operate on an arbitrary contiguous part of the
current buffer. To specify the text for such a command to operate on,
you set "the mark" at one end of it, and move point to the other end.
The text between point and the mark is called "the region". The region
always extends between point and the mark, no matter which one comes
earlier in the text; each time you move point, the region changes.

You can read more about the mark and the region in the Emacs manual:
* {{Manual|emacs|Mark|Mark}}

== Killing ==

In Emacs, "killing" means erasing text and copying it into the "kill
ring". "Yanking" means bringing text from the kill ring back into the
buffer. (Some applications use the terms "cutting" and "pasting" for
similar operations.) The kill ring is so-named because it can be
visualized as a set of blocks of text arranged in a ring, which you can
access in cyclic order.

You can read more about killing in the Emacs manual:
* {{Manual|emacs|Killing|Killing}}

== Yanking ==

"Yanking" means reinserting text previously killed. The usual way to
move or copy text is to kill it and then yank it elsewhere one or more
times.

You can read more about Yanking in the Emacs manual:
* {{Manual|emacs|Yanking|Yanking}}

== Faces ==

Emacs can display text in several different styles, which are called faces. Each face can specify various face attributes, such as the font, height, weight and slant, the foreground and background color, and underlining or overlining. A face does not have to specify all of these attributes; often it inherits most of them from another face.

On a text-only terminal, not all face attributes are meaningful. Some text-only terminals support inverse video, bold, and underline attributes; some support colors. Text-only terminals generally do not support changing the height, width or font.

Most major modes assign faces to the text automatically through the work of Font Lock mode. See Font Lock, for more information about Font Lock mode and syntactic highlighting. You can print the current buffer with the highlighting that appears on your screen using the command {{Command|ps-print-buffer-with-faces}}.

You can read more about faces in the Emacs manual:
* {{Manual|emacs|Faces|Faces}}

== Major mode ==

Emacs can adapt its behaviour to the specific type of text edited in a buffer. The set of specific Emacs customizations for a particular type of text is called a "major mode". Each buffer has exactly one major mode depending on its content type (but see [[MuMaMo]] for a way to relax this constraint).

Major modes can change the meaning of some keys, define syntax highlighing or indentation rules, and install new key bindings (usually beginning with {{Keys|C-c}}) for mode-specific commands. Emacs ships with a wide range of major modes, falling into three main categories:
* support for text (e.g. [[:Category:Markup languages|markup languages]]),
* support for [[:Category:Programming languages|programming languages]],
* applications within emacs (e.g. [[dired]], [[gnus]], ...). Buffers using this last group of major modes are usually not associated to files, but rather serve as a user interface.

You can read more about major modes in the Emacs manual:
* {{Manual|emacs|Major-Modes|Major Modes}}

== Minor mode ==

Minor modes are optional features that can be turned on and off. Minor modes can be enabled for specific buffers (''buffer-local'' modes) or all buffers (''global'' modes).

Emacs provides lots of minor modes. Just a few examples:

* [[Auto Fill]] mode to automatically [[#Fill]] text as you type.
* [[Flyspell]] mode to highlight spelling errors as you type.
* [[Visual Line]] mode to wrap long lines to fit the screen. (See [[#Screen Lines]])
* [[Transient Mark]] mode to highlight the current region.

You can read more about minor modes in the Emacs manual:
* {{Manual|emacs|Minor-Modes|Minor Modes}}

== Fill ==

In Emacs ''filling'' text means breaking it in to lines of a given maximum width. You can enable automatic filling with {{Command|auto-fill-mode}}, or fill a specific block of text using something like {{CommandKeys|M-q|fill-paragraph}}.

Note that fill commands add hard line breaks to the text. This is different from what might be called "word wrap" (or "line wrap") in other tools, where the text is wrapped at the edge of the current display and re-flowed if the window is resized. Emacs provides this sort of wrapping as well, see [[#Screen Lines]]

You can read about the various ways to fill text in the Emacs manual:
* {{Manual|emacs|Filling|Filling}}

== Screen Lines ==

Emacs provides several ways to deal with text lines that extend horizontally beyond the size of the current window. These are display features: they change the ''screen lines'' shown in the window without modifying the ''logical lines'' of the actual text.

* By default, Emacs wraps a long line of text at the edge of the window and shows the remaining text in ''continuation lines''.
* [[Visual Line]] mode provides what is commonly called "word wrap": long lines are wrapped at the edge of the window without breaking in the middle of a word. Try {{Command|visual-line-mode}}.
* ''Line truncation'' means that text beyond the edge of the display is simply not shown, i.e. the line is cut off. Try {{Command|toggle-truncate-lines}}.

These display options can affect how some editing and movement commands work. Refer to the documentation for details. To reformat text with hard line breaks, see [[#Fill]].

You can read more about the various ways of visualizing long lines in the Emacs manual:
* {{Manual|emacs|Continuation-Lines|Continuation Lines}}
* {{Manual|emacs|Visual-Line-Mode|Visual Line Mode}}
* {{Manual|emacs|Line-Truncation|Line Truncation}}

== case-fold ==

Case '''in'''sensitivity.

== Narrow and widen ==

Sometimes you want to work on just a portion of the current buffer and ignore the rest. Emacs provides commands to ''narrow'' the display so that it only shows the text you are interested in. Text outside of the current ''restriction'' is hidden from view and inaccessible to editing commands.

Use {{CommandKeys|C-x n n|narrow-to-region}} to narrow the display to the current region. Use {{CommandKeys|C-x n w|widen}} to ''widen'' the display, making the entire buffer accessible again.

Note that narrowing can be confusing to new users, so the command <tt>narrow-to-region</tt> is disabled by default. If you have not explicitly enabled this command before trying to use it, you will be prompted to do so.

Narrowing can be considered an alternative to collapsing blocks of text (folding). Narrowing allows you to identify a block of text to edit, whereas folding allows you to identify a block of text to hide. Emacs has various ways to hide text (see [[#Selective Display]]). The key difference between hiding text and narrowing is that hidden text remains editable: you can still delete a block of text that has been collapsed from view. With a narrowing restriction, only the active text can be modified.

You can read more about narrowing and other ways to hide text in the Emacs manual:
* {{Manual|emacs|Narrowing|Narrowing}}

== Selective Display ==

Emacs provides a way to hide lines of text indented more than a given number of columns:
{{Command|set-selective-display}}, bound to {{Keys|C-x $}} by default.

This can be useful to hide "details" and get an overview of a file that uses indentation in some meaningful way (like most programming langauges). Note that the hidden text remains editable; see [[#Narrowing]] for a safer way to edit a specific portion of a buffer.

There are a variety of other ways to hide text in an Emacs buffer, such as [[Outline]] and [[Hideshow]] modes.

You can read more about selective display in the Emacs manual:
* {{Manual|emacs|Selective-Display|Selective Display}}

[[Category:Beginner]]

== font-lock ==

Syntax highlighting.

[[Category:Key Concepts]] [[Category:Emacs Terminology]] [[Category:Beginner]]

Category:Major modes

2012-04-01T21:04:17Z

Francesco: Created page with "Here are major modes which will help you edit specific types of text."

Here are [[Major mode|major modes]] which will help you edit specific types of text.

Template:Infobox major-mode

2012-04-01T21:02:08Z

Francesco: added auto-categorization

<includeonly>
{{Infobox
|bodystyle = width:30em;
|title = {{{title}}}

|header1 =
|label1 = Library
|data1 = {{{library}}}
|header2 =
|label2 = Command
|data2 = {{{command}}}
|header3 =
|label3 = Builtin
|data3 = {{{builtin}}}
|header4 =
|label4 = Auto-activates for
|data4 = {{#if:{{{auto activates|}}}|<tt>{{{auto activates}}}</tt>}}
}}
[[Category:Major modes]]
</includeonly>
<noinclude>
{{Infobox major-mode
|title = C++
|library = cc-mode
|command = c++-mode
|builtin = yes
|auto activates = *.ii, *.CC, *.HH, *.cpp, *.hpp, *.cxx, *.hxx, *.c++, *.h++, *.cc, *.hh
}}

Generate a major-mode infobox.

<pre>{{Infobox major-mode
|title = C++
|library = cc-mode
|command = c++-mode
|builtin = yes
|auto activates = *.ii, *.CC, *.HH, *.cpp, *.hpp, *.cxx, *.hxx, *.c++, *.h++, *.cc, *.hh
}}</pre>
will generate the infobox shown at the top right corner of this page.

[[Category:Emacs Wiki Templates]]
</noinclude>

Template:Infobox major-mode

2012-04-01T20:21:50Z

Francesco:

<includeonly>
{{Infobox
|bodystyle = width:30em;
|title = {{{title}}}

|header1 =
|label1 = Library
|data1 = {{{library}}}
|header2 =
|label2 = Command
|data2 = {{{command}}}
|header3 =
|label3 = Builtin
|data3 = {{{builtin}}}
|header4 =
|label4 = Auto-activates for
|data4 = {{#if:{{{auto activates|}}}|<tt>{{{auto activates}}}</tt>}}
}}
</includeonly>
<noinclude>
{{Infobox major-mode
|title = C++
|library = cc-mode
|command = c++-mode
|builtin = yes
|auto activates = *.ii, *.CC, *.HH, *.cpp, *.hpp, *.cxx, *.hxx, *.c++, *.h++, *.cc, *.hh
}}

Generate a major-mode infobox.

<pre>{{Infobox major-mode
|title = C++
|library = cc-mode
|command = c++-mode
|builtin = yes
|auto activates = *.ii, *.CC, *.HH, *.cpp, *.hpp, *.cxx, *.hxx, *.c++, *.h++, *.cc, *.hh
}}</pre>
will generate the infobox shown at the top right corner of this page.

[[Category:Emacs Wiki Templates]]
</noinclude>

Template:Infobox major-mode

2012-04-01T20:21:13Z

Francesco: made "auto activates" field optional

<includeonly>
{{Infobox
|bodystyle = width:30em;
|title = {{{title}}}

|header1 =
|label1 = Library
|data1 = {{{library}}}
|header2 =
|label2 = Command
|data2 = {{{command}}}
|header3 =
|label3 = Builtin
|data3 = {{{builtin}}}
|header4 =
|label4 = Auto-activates for
|data4 = {{#if{{{auto activates|}}}|<tt>{{{auto activates}}}</tt>}}
}}
</includeonly>
<noinclude>
{{Infobox major-mode
|title = C++
|library = cc-mode
|command = c++-mode
|builtin = yes
|auto activates = *.ii, *.CC, *.HH, *.cpp, *.hpp, *.cxx, *.hxx, *.c++, *.h++, *.cc, *.hh
}}

Generate a major-mode infobox.

<pre>{{Infobox major-mode
|title = C++
|library = cc-mode
|command = c++-mode
|builtin = yes
|auto activates = *.ii, *.CC, *.HH, *.cpp, *.hpp, *.cxx, *.hxx, *.c++, *.h++, *.cc, *.hh
}}</pre>
will generate the infobox shown at the top right corner of this page.

[[Category:Emacs Wiki Templates]]
</noinclude>

Markdown

2012-04-01T20:17:27Z

Francesco: added major-mode infobox

{{Infobox major-mode
|title=Markdown
|library=markdown-mode
|command=markdown-mode
|builtin=no
}}

[http://jblevins.org/projects/markdown-mode/ Markdown Mode] provides a major mode for editing Markdown-formatted text files.

This package is not currently part of the Emacs distribution.

= External Links =

* [http://jblevins.org/projects/markdown-mode/ Markdown Mode Project]
* [http://jblevins.org/git/markdown-mode.git Source (git)]

[[Category:Markup languages]][[Category:Document authoring]]

User:Francesco

2012-04-01T20:13:28Z

Francesco:

I use emacs on a daily basis, mostly for
* software development (C++, Python)
* document authoring (LaTeX)
* organizing my work (org)

[[Category:WikEmacs Contributor]]

Template:Package

2012-03-29T21:15:04Z

Francesco: fixed bug

<includeonly>
{{Infobox
| title = {{{name|package name}}}
| label1 = Description
| data1 = {{{description|simple one line description}}}
| label2 = Maintainer
| data2 = {{{maintainer|name of maintainer}}}
| label3 = Source Code
| data3 = {{{source|'''no link provided'''}}}
| {{#if: {{{in_emacs|}}}||NULL}}label4 = Part of Emacs since
| {{#if: {{{in_emacs|}}}||NULL}}data4 = {{#if: {{{in_emacs|}}}|{{{in_emacs}}}}}
}}</includeonly><noinclude>

== Usage ==

This template is used for adding a Emacs Packages to the wiki and formating a nice bit of boiler plate and auto-categorisation. Parameters include:

* name - Name of package
* description - One line description
* maintainer - The maintainer
* source - Where the source code lives
* (optional) in_emacs - When the package was included in emacs

{{Package
|name=edit-server.el
|description=Provide an edit server for Chrom(ium) browser extensions
|maintainer=Alex Bennée
|source=https://github.com/stsquad/emacs_chrome/blob/master/servers/edit-server.el
|category=
}}

By using this template to declare a package you automatically include the page in the [[:Category:Emacs Package|Emacs Package category]]

The sample box shown here is defined using:
<pre>
{{Package
|name=edit-server.el
|description=Provide an edit server for Chrom(ium) browser extensions
|maintainer=Alex Bennée
|source=https://github.com/stsquad/emacs_chrome/blob/master/servers/edit-server.el
}}
</pre>




</noinclude>

Emacs Lisp

2012-03-29T19:41:54Z

Francesco: added infobox

{{Infobox major-mode
|title = Emacs Lisp
|library = lisp-mode
|command = emacs-lisp-mode
|builtin = yes
|auto activates = *.el, .emacs, _emacs
}}

Emacs Lisp is a dialect of the [[Lisp]] programming language used by GNU Emacs. Most of the editing functionality built into Emacs is written in Emacs Lisp, with the remainder being written in C (as is the Lisp interpreter itself). Users of Emacs commonly write Emacs Lisp code to customize and extend Emacs.

Emacs Lisp is also commonly referred to as "elisp" or "Elisp". Files containing Emacs Lisp code use the <tt>.el</tt> filename suffix; when [[byte-compile]]d, the same filename prefix is used but with the <tt>.elc</tt> filename suffix.

Emacs Lisp is a [https://hornbeck.wordpress.com/2009/07/05/lisp-1-vs-lisp-2/ Lisp-2], which means that a single identifier (in Lisp terminology, "symbol") can simultaneously exist as ("be bound to") both a function and a variable.

= Basic setup =

You can customize the way Emacs edits and displays this and all other [[:Category:Lisp|lisp languages]] with {{CustomizeGroup|lisp}}.

= Helpful keybindings =

; {{Keys|M-<tab>}}
: Complete at point

; {{Keys|C-M-q}}
: Indent the [[S-expression]] following [[point and mark|point]]

;{{Keys|C-M-x}}
: Evaluate the <code>defun</code> at [[point and mark|point]]

= Common customizations =

== Outlining ==

For [[Org]]-style outlining, add the following snippet to your {{EmacsConfigFile}}.

<source lang="lisp">
;; Turn on outline minor mode
(add-hook 'emacs-lisp-mode-hook 'outline-minor-mode)

;; Add key bindings for Org-style outline cycling
(add-hook 'outline-minor-mode-hook
(lambda ()
(define-key outline-minor-mode-map [(control tab)] 'org-cycle)
(define-key outline-minor-mode-map [(shift tab)] 'org-global-cycle)))
</source>

Now visit any elisp file (say {{Command|find-library RET outline}}) and keep pressing {{Keys|S-TAB}} and see what happens. Experiment similarly with {{Keys|C-TAB}}.

== Indentation ==

Add the following snippet to your {{EmacsConfigFile}}, so that you don't have to indent deliberately. See {{Command|reindent-then-newline-and-indent}}.

<source lang="lisp">
(add-hook 'emacs-lisp-mode-hook
(lambda nil
(local-set-key [(return)] 'reindent-then-newline-and-indent)))
</source>

== Always keep parentheses balanced ==

See [[Skeleton#Keep some chars always balanced]]

== Scope ==
By default elisp uses [[dynamic scope]]. Since Emacs 24 [[lexical scope]] has been added. <br/>
To use lexical binding, an Emacs-lisp source file must set a file-variable {{Variable|lexical-binding}} to <tt>t</tt> in the file header, e.g., by using a first line like: <br/>

;;; -*- lexical-binding: t -*-

= External links =

* [http://www.gnu.org/software/emacs/manual/html_node/elisp/index.html Emacs Lisp manual]

[[Category:Emacs User]][[Category:Emacs Contributor]][[Category:Intermediate]][[Category:Lisp]]

Template:Infobox major-mode

2012-03-29T19:33:44Z

Francesco:

<includeonly>
{{Infobox
|bodystyle = width:30em;
|title = {{{title}}}

|header1 =
|label1 = Library
|data1 = {{{library}}}
|header2 =
|label2 = Command
|data2 = {{{command}}}
|header3 =
|label3 = Builtin
|data3 = {{{builtin}}}
|header4 =
|label4 = Auto-activates for
|data4 = <tt>{{{auto activates}}}</tt>
}}
</includeonly>
<noinclude>
{{Infobox major-mode
|title = C++
|library = cc-mode
|command = c++-mode
|builtin = yes
|auto activates = *.ii, *.CC, *.HH, *.cpp, *.hpp, *.cxx, *.hxx, *.c++, *.h++, *.cc, *.hh
}}

Generate a major-mode infobox.

<pre>{{Infobox major-mode
|title = C++
|library = cc-mode
|command = c++-mode
|builtin = yes
|auto activates = *.ii, *.CC, *.HH, *.cpp, *.hpp, *.cxx, *.hxx, *.c++, *.h++, *.cc, *.hh
}}</pre>
will generate the infobox shown at the top right corner of this page.

</noinclude>

Template:Infobox major-mode

2012-03-29T19:32:40Z

Francesco: documentation

<includeonly>
{{Infobox
|bodystyle = width:30em;
|title = {{{title}}}

|header1 =
|label1 = Library
|data1 = {{{library}}}
|header2 =
|label2 = Command
|data2 = {{{command}}}
|header3 =
|label3 = Builtin
|data3 = {{{builtin}}}
|header4 =
|label4 = Auto-activates for
|data4 =  {{{auto activates}}}
}}
</includeonly>
<noinclude>
{{Infobox major-mode
|title = C++
|library = cc-mode
|command = c++-mode
|builtin = yes
|auto activates = *.ii, *.CC, *.HH, *.cpp, *.hpp, *.cxx, *.hxx, *.c++, *.h++, *.cc, *.hh
}}

Generate a major-mode infobox.

<pre>{{Infobox major-mode
|title = C++
|library = cc-mode
|command = c++-mode
|builtin = yes
|auto activates = *.ii, *.CC, *.HH, *.cpp, *.hpp, *.cxx, *.hxx, *.c++, *.h++, *.cc, *.hh
}}</pre>
will generate the infobox shown at the top right corner of this page.

</noinclude>

Template:Infobox major-mode

2012-03-29T19:06:53Z

Francesco:

Template:Infobox major-mode

2012-03-29T19:05:34Z

Francesco:

Template:Infobox major-mode

2012-03-29T19:03:03Z

Francesco:

Template:Infobox major-mode

2012-03-29T19:01:47Z

Francesco: Created page with "<includeonly> {{Infobox |bodystyle = width:30em; |title = {{{title}}} |header1 = |label1 = Library |data1 = {{{library}}} |header2 = |label2 = Comm..."

WikEmacs:Scratch Buffer

2012-03-29T18:19:09Z

Francesco: test for a major-mode infobox

[[Text Editing]]

{{Snippet|
(this (is
("a test")))}}

{|
|+ capiton
|-
| EST
| New York
| -5:00
|-
| IST
| Madras
| +5:30
|-
| AST
| Bahrain
|
|}

{{Infobox major-mode
| name = C++
| command = c++-mode
| library = cc-mode
}}

Category:Beginner

2012-03-28T18:31:50Z

Francesco:

If you're new to Emacs, you should be interested by the pages listed here. If you've never been exposed to conventional Emacs notations or terminology, you should probably get started by reading the following articles first:
* [[How to read this wiki]]
* [[Emacs Terminology]]

[[Category:User Level]]

How to read this wiki

2012-03-28T18:25:15Z

Francesco: /* Links to official manual sections */

A few conventions and notations are used throughout this wiki. Most of them are very similar to those used in the Emacs Manual

== Key bindings and commands ==

The notation {{Keys|C-M-a}}, denotes a key binding. Here, '''<tt>C-</tt>''' represents the ''<Control>'' key (which is labelled ''<Ctrl>'' on most keyboards), '''<tt>M-</tt>''' represents the ''<Meta>'' key (which is labelled ''<Alt>'' on most keyboards), and '''</tt>a</tt>''' simply represents the ''a'' key. Thus, to produce this key combination, you should press simultaneously the ''<Ctrl>'', ''<Alt>'', and ''a'' keys on your keyboard.

You can form sequences of key bindings. For example {{Keys|C-x C-c}} denotes the {{Keys|C-x}} key combination (i.e. ''<ctrl>''+''x'') followed by the {{Keys|C-c}} key combination (i.e. ''<ctrl>''+''c'').

Below is a list of some keys you might encounter on this wiki:

{|
! notation
! corresponding key
|-
| '''<tt>C-</tt>'''
| <Ctrl>
|-
| '''<tt>M-</tt>'''
| <Meta> or <Alt>
|-
| '''<tt>S-</tt>'''
| <Shift>
|-
| '''<tt>left</tt>'''
| <left arrow> (similar notations are used for all arrow keys)
|-
| '''<tt>RET</tt>'''
| <return>
|}

Sometimes, the command bound to a key sequence is listed next to it in this way: {{CommandKeys|C-x C-f|find-file}}.

This means that instead of typing the {{Keys|C-x C-f}} key binding, you could achieve the same effect by typing:
: '''<tt>M-x find-file RET</tt>'''

== Links to official manual sections ==

This wiki does not aim at reproducing official GNU documentation. Instead, it links to it using this notation: {{Manual|emacs|Major-Modes|Major Modes}}.

You can of course click on the link to view the relevant manual section (in this case, the "Major Modes" section of the Emacs manual). But since Emacs is self-documented, you can also directly see the documentation within Emacs, by typing:
: '''<tt>M-: (info "(emacs) Major Modes") RET</tt>'''

[[Category:Beginner]]

How to read this wiki

2012-03-28T18:23:17Z

Francesco: /* Key bindings */

A few conventions and notations are used throughout this wiki. Most of them are very similar to those used in the Emacs Manual

== Key bindings and commands ==

The notation {{Keys|C-M-a}}, denotes a key binding. Here, '''<tt>C-</tt>''' represents the ''<Control>'' key (which is labelled ''<Ctrl>'' on most keyboards), '''<tt>M-</tt>''' represents the ''<Meta>'' key (which is labelled ''<Alt>'' on most keyboards), and '''</tt>a</tt>''' simply represents the ''a'' key. Thus, to produce this key combination, you should press simultaneously the ''<Ctrl>'', ''<Alt>'', and ''a'' keys on your keyboard.

You can form sequences of key bindings. For example {{Keys|C-x C-c}} denotes the {{Keys|C-x}} key combination (i.e. ''<ctrl>''+''x'') followed by the {{Keys|C-c}} key combination (i.e. ''<ctrl>''+''c'').

Below is a list of some keys you might encounter on this wiki:

{|
! notation
! corresponding key
|-
| '''<tt>C-</tt>'''
| <Ctrl>
|-
| '''<tt>M-</tt>'''
| <Meta> or <Alt>
|-
| '''<tt>S-</tt>'''
| <Shift>
|-
| '''<tt>left</tt>'''
| <left arrow> (similar notations are used for all arrow keys)
|-
| '''<tt>RET</tt>'''
| <return>
|}

Sometimes, the command bound to a key sequence is listed next to it in this way: {{CommandKeys|C-x C-f|find-file}}.

This means that instead of typing the {{Keys|C-x C-f}} key binding, you could achieve the same effect by typing:
: '''<tt>M-x find-file RET</tt>'''

== Links to official manual sections ==

This wiki does not aim at reproducing official GNU documentation. Instead, it links to it using this notation: {{Manual|emacs|Major-Modes|Major Modes}}. You can of course click on the link to view the relevant manual section (in this case, the "Major Modes" section of the Emacs manual). But since Emacs is self-documented, you can also directly see the documentation within Emacs, by typing:
: '''M-: (info "(emacs) Major Modes") RET'''

[[Category:Beginner]]