Emacs: Tab/Indent Setup

By Xah Lee. Date: . Last updated: .

Set Default Tab Display Width

Put this in your Emacs Init File:

;; set default tab char's display width to 4 spaces
(setq-default tab-width 4) ; emacs 23.1 to 26 default to 8

;; set current buffer's tab char's display width to 4 spaces
(setq tab-width 4)

Set Indent Commands to Always Use Space Only

(progn
  ;; make indent commands use space only (never tab character)
  (setq-default indent-tabs-mode nil)
  ;; emacs 23.1 to 26, default to t
  ;; if indent-tabs-mode is t, it means it may use tab, resulting mixed space and tab
  )

Set Indent Commands to Always Use Tab Characters Only

There is no easy way to do it globally.

You need to look into each Major Mode 's documentation, and see if it supports that feature.

A simple workaround, is just to insert/delete literal tab yourself for indentation.

You can insert a literal tab by Ctrl+q Tab .

Or, you can make the Tab key to always insert a literal tab.

(defun my-insert-tab-char ()
  "Insert a tab char. (ASCII 9, \t)"
  (interactive)
  (insert "\t"))

(global-set-key (kbd "TAB") 'my-insert-tab-char)

But major mode may override your key. You can force your Tab keybinding by using a hook for a major mode. [see Emacs: Change Major Mode Keys]

Make Tab Key Do Indent or Completion

Here's the official GNU Emacs's convention for controlling what the Tab key does, globally for programing language major modes:

;; make tab key always call a indent command.
(setq-default tab-always-indent t)

;; make tab key call indent command or insert tab character, depending on cursor position
(setq-default tab-always-indent nil)

;; make tab key do indent first then completion.
(setq-default tab-always-indent 'complete)

Note:

If you really want to control what the Tab key does, just hard set that key directly to a command of your choice. The disadvantage is that completion packages such as yasnippet that by default uses Tab key, may not work automatically.

Here's example:

;; example of a function that just insert a tab char
(defun my-insert-tab-char ()
  "insert a tab char. (ASCII 9, \t)"
  (interactive)
  (insert "\t")
)

(global-set-key (kbd "TAB") 'my-insert-tab-char)
(global-set-key (kbd "<tab>") 'my-insert-tab-char)

;; • the syntax (kbd "TAB") corresponds to ASCII 9 control character, which is also equivalent to (kbd "C-i"). At the core, Emacs uses characters with control bits to represent key press.

;; • the syntax (kbd "<tab>") is the tab key, higher level. when emacs is running in GUI, it can distinguish <tab> key vs the ASCII control character ASCII 9.

;; • by default (kbd "<tab>") is translated to (kbd "TAB").

To make sure that major mode does not override your key, see Emacs: Change Major Mode Keys

[see Emacs: How to Define Keybinding]

Make Return Key Also Do Indent of Previous Line

Put this in your Emacs Init File:

;; make return key also do indent, for current buffer only
(electric-indent-local-mode 1)

;; make return key also do indent, globally
(electric-indent-mode 1)

Emacs, Tab, Indentation, Whitespace


Emacs Init

Init Basics

Keys

Font

Text Editing

Completion

File

Restore Things

Backup/AutoSave

Line

Appearance

Misc

Advanced Init Tips

packages