FileLocalVariables

See also: LocalVariables, DirectoryVariables

File-local variables can be used to make certain configurations local to a file. This might be useful for setting the indention level of a C program as well as setting the MajorMode to use for this file. This mechanism is regularly used in multi-document LaTeX projects where AUCTeX stores the information about the master document so it can compile the right one when the user invokes the LaTeX command (usually via C-c C-c).

These settings may be located in a comment on the first line of the file (or one of the first two lines, if the file starts with #!), in which case they are wrapped by the special marker -*-. e.g.:

 ;; -*- mode: emacs-lisp; fill-column: 75; comment-column: 50; -*-

Note that mode is a pseudo-variable, and that its value does not contain the -mode suffix. (Other pseudo-variables are coding, unibyte, and eval.)

Otherwise (or additionally) they are located at the end of your file, in a comment block like this:

 # Local Variables:
 # mode: ksh
 # fill-column: 75
 # comment-column: 50
 # End:

i.e. there is a special keyword Local Variables: which starts the section and is surrounded by a prefix (”# “ in the above example) and a postfix (empty here). The keyword End: (with the same post- and prefixes) finishes that section. Obviously the prefix and postfixes are important to comment those lines according to the file-type.

For detailed documentation, see File Variables.

As of Emacs 24: Using mode: MINOR-MODE to enable a minor mode is deprecated.
Instead, use eval: (minor-mode 1)

Funny Side Effect

If you create a file containing the following lines you won’t be able to open it:

 -*- normal -*-
 
 ;; Local variables:
 ;; enable-local-eval: t
 ;; hack-local-variables-hook: save-buffers-kill-emacs
 ;; end:

AFAI remember that stems from an effect that in normal-mode the local variables are processed in a special way. Of course one could do severe damage with such a text file and I have a bad feeling towards this. If I am missing something here I’d be happy to learn what. – StefanKamphausen

Aborting the file open with C-g and then opening it with C-x C-f allows you to open the file (for some reason). Also, you can always open it with find-file-literally. – fledermaus

Disabling File Local Variables

;; Turn off file variables
;; See: http://www.gnu.org/software/emacs/manual/html_node/emacs/Safe-File-Variables.html#Safe-File-Variables
(setq enable-local-variables nil
      enable-local-eval nil)

Using Directory Local Variable classes for individual files

This is actually using DirectoryVariables, but seems more useful to document here.

Directory Local Variables can be configured purely in elisp by configuring “directory classes” and specifying which classes apply to which directories.

There is no such mechanism for File Local Variables, but it turns out that we can successfully* apply directory classes to individual files. The only issue is that dir-locals-set-directory-class calls file-name-as-directory on its argument, which prevents it from being matched, due to the trailing slash.

The following, therefore, is a way to configure directory local variables for a single file, without modifying the file itself, or affecting other files under the same parent directory.

(defun my-file-locals-set-directory-class (file class &optional mtime)
  "Enable 'directory local' classes for individual files,
by allowing non-directories in `dir-locals-directory-cache'.
Adapted from `dir-locals-set-directory-class'."
  (setq file (expand-file-name file))
  (unless (assq class dir-locals-class-alist)
    (error "No such class `%s'" (symbol-name class)))
  (push (list file class mtime) dir-locals-directory-cache))

(dir-locals-set-class-variables
 'my-javascript-class
 '((nil . ((js-indent-level . 2)
           (indent-tabs-mode . nil)))))

(my-file-locals-set-directory-class
 "path/to/the/file.js" 'my-javascript-class)

* tested with Emacs 23.3.1