Mercurial > emacs
view doc/emacs/indent.texi @ 108035:98d289f97679
get rid of "unix" pre-defined macro when preprocessing Makefile
author | Miles Bader <miles@gnu.org> |
---|---|
date | Thu, 22 Apr 2010 09:10:30 +0900 |
parents | ec5432ca82a4 |
children | 376148b31b5e |
line wrap: on
line source
@c This is part of the Emacs manual. @c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 2001, 2002, @c 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. @c See file emacs.texi for copying conditions. @node Indentation, Text, Major Modes, Top @chapter Indentation @cindex indentation @cindex tabs @cindex columns (indentation) This chapter describes the Emacs commands that add, remove, or adjust indentation. @table @kbd @item @key{TAB} Indent the current line appropriately, in a mode-dependent fashion. @item @kbd{C-j} Perform @key{RET} followed by @key{TAB} (@code{newline-and-indent}). @item M-^ Merge the previous and the current line (@code{delete-indentation}). This would cancel the effect of a preceding @kbd{C-j}. @item C-M-o Split the current line at point; text on the line after point becomes a new line indented to the same column where point is located (@code{split-line}). @item M-m Move (forward or back) to the first nonblank character on the current line (@code{back-to-indentation}). @item C-M-\ Indent lines in the region to the same column (@code{indent-region}). @item C-x @key{TAB} Shift lines in the region rigidly right or left (@code{indent-rigidly}). @item M-i Indent from point to the next prespecified tab stop column (@code{tab-to-tab-stop}). @item M-x indent-relative Indent from point to under an indentation point in the previous line. @end table @noindent The @key{TAB} key runs @code{indent-for-tab-command} in most major modes (in C and related modes, @key{TAB} runs a separate command, @code{c-indent-line-or-region}, which behaves similarly). The major mode determines just what this entails. In text modes, @key{TAB} inserts some combination of space and tab characters to advance point to the next tab stop (@pxref{Tab Stops}). If the region is active and spans multiple lines, it advances the first character of each of those lines to the next tab stop (@pxref{Using Region}). For the purposes of this command, the position of the first non-whitespace character on the preceding line is treated as an additional tab stop. Thus, you can use @key{TAB} to ``align'' point with the preceding line. In programming modes, @key{TAB} adds or removes some combination of space and tab characters at the start of the line, in a way that makes sense given the text in the preceding lines. If the region is active and spans multiple lines, all those lines are indented this way. If point was initially within the current line's indentation, it is positioned after that indentation; otherwise, it remains at same point in the newly-indented text. @xref{Program Indent}. @vindex tab-width Normally, indentation commands insert (or remove) an optimal mix of @dfn{tab characters} and spaces to align to the desired column. Tab characters (@acronym{ASCII} code 9) are displayed as a stretch of empty space extending to the next @dfn{display tab stop}. By default, there is one display tab stop every eight columns; the number of columns is determined by the variable @code{tab-width}. You can insert a single tab character by typing @kbd{C-q @key{TAB}}. @xref{Text Display}. @findex edit-tab-stops @findex tab-to-tab-stop @kindex M-i The command @kbd{M-i} (@code{tab-to-tab-stop}) adjusts the whitespace characters around point, inserting just enough whitespace to advance point up to the next tab stop. By default, this involves deleting the existing whitespace and inserting a single tab character. @xref{Just Spaces}, for how to disable use of tabs. However, @kbd{C-q @key{TAB}} always inserts a tab, even when tabs are disabled for the indentation commands. @vindex tab-always-indent The variable @code{tab-always-indent} tweaks the behavior of the @key{TAB} (@code{indent-for-tab-command}) command. The default value, @code{t}, gives the behavior described above. If you change the value to the symbol @code{complete}, then @key{TAB} first tries to indent the current line, and if the line was already indented, it tries to complete the text at point (@pxref{Symbol Completion}). If the value is @code{nil}, then @key{TAB} indents the current line only if point is at the left margin or in the line's indentation; otherwise, it inserts a real tab character. @menu * Indentation Commands:: Various commands and techniques for indentation. * Tab Stops:: You can set arbitrary "tab stops" and then indent to the next tab stop when you want to. * Just Spaces:: You can request indentation using just spaces. @end menu @node Indentation Commands, Tab Stops, Indentation, Indentation @section Indentation Commands and Techniques @kindex M-m @findex back-to-indentation To move over the indentation on a line, do @kbd{M-m} (@code{back-to-indentation}). This command, given anywhere on a line, positions point at the first nonblank character on the line, if any, or else at the end of the line. To insert an indented line before the current line, do @kbd{C-a C-o @key{TAB}}. To make an indented line after the current line, use @kbd{C-e C-j}. If you just want to insert a tab character in the buffer, type @kbd{C-q @key{TAB}}. @kindex C-M-o @findex split-line @kbd{C-M-o} (@code{split-line}) moves the text from point to the end of the line vertically down, so that the current line becomes two lines. @kbd{C-M-o} first moves point forward over any spaces and tabs. Then it inserts after point a newline and enough indentation to reach the same column point is on. Point remains before the inserted newline; in this regard, @kbd{C-M-o} resembles @kbd{C-o}. @kindex M-^ @findex delete-indentation To join two lines cleanly, use the @kbd{M-^} (@code{delete-indentation}) command. It deletes the indentation at the front of the current line, and the line boundary as well, replacing them with a single space. As a special case (useful for Lisp code) the single space is omitted if the characters to be joined are consecutive open parentheses or closing parentheses, or if the junction follows another newline. To delete just the indentation of a line, go to the beginning of the line and use @kbd{M-\} (@code{delete-horizontal-space}), which deletes all spaces and tabs around the cursor. If you have a fill prefix, @kbd{M-^} deletes the fill prefix if it appears after the newline that is deleted. @xref{Fill Prefix}. @kindex C-M-\ @kindex C-x TAB @findex indent-region @findex indent-rigidly There are also commands for changing the indentation of several lines at once. They apply to all the lines that begin in the region. @kbd{C-M-\} (@code{indent-region}) indents each line in the ``usual'' way, as if you had typed @key{TAB} at the beginning of the line. A numeric argument specifies the column to indent to, and each line is shifted left or right so that its first nonblank character appears in that column. @kbd{C-x @key{TAB}} (@code{indent-rigidly}) moves all of the lines in the region right by its argument (left, for negative arguments). The whole group of lines moves rigidly sideways, which is how the command gets its name. @cindex remove indentation To remove all indentation from all of the lines in the region, invoke @kbd{C-x @key{TAB}} with a large negative argument, such as -1000. @findex indent-relative @kbd{M-x indent-relative} indents at point based on the previous line (actually, the last nonempty line). It inserts whitespace at point, moving point, until it is underneath the next indentation point in the previous line. An indentation point is the end of a sequence of whitespace or the end of the line. If point is farther right than any indentation point in the previous line, @code{indent-relative} runs @code{tab-to-tab-stop} @ifnottex (@pxref{Tab Stops}), @end ifnottex @iftex (see next section), @end iftex unless it is called with a numeric argument, in which case it does nothing. @xref{Format Indentation}, for another way of specifying the indentation for part of your text. @node Tab Stops, Just Spaces, Indentation Commands, Indentation @section Tab Stops @cindex tab stops @cindex using tab stops in making tables @cindex tables, indentation for @kindex M-i @findex tab-to-tab-stop For typing in tables, you can use @kbd{M-i} (@code{tab-to-tab-stop}). This command inserts indentation before point, enough to reach the next tab stop column. @findex edit-tab-stops @findex edit-tab-stops-note-changes @kindex C-c C-c @r{(Edit Tab Stops)} @vindex tab-stop-list You can change the tab stops used by @kbd{M-i} and other indentation commands, so that they need not be spaced every eight characters, or even regularly spaced. The tab stops are stored in the variable @code{tab-stop-list}, as a list of column numbers in increasing order. A convenient way to set the tab stops is with @kbd{M-x edit-tab-stops}, which creates and selects a buffer containing a description of the tab stop settings. You can edit this buffer to specify different tab stops, and then type @kbd{C-c C-c} to make those new tab stops take effect. The buffer uses Overwrite mode (@pxref{Minor Modes}). @code{edit-tab-stops} records which buffer was current when you invoked it, and stores the tab stops back in that buffer; normally all buffers share the same tab stops and changing them in one buffer affects all, but if you happen to make @code{tab-stop-list} local in one buffer then @code{edit-tab-stops} in that buffer will edit the local settings. Here is what the text representing the tab stops looks like for ordinary tab stops every eight columns. @example : : : : : : 0 1 2 3 4 0123456789012345678901234567890123456789012345678 To install changes, type C-c C-c @end example The first line contains a colon at each tab stop. The remaining lines are present just to help you see where the colons are and know what to do. Note that the tab stops that control @code{tab-to-tab-stop} have nothing to do with how tab characters are displayed in the buffer. Tab characters are always displayed as empty spaces extending to the next display tab stop, which occurs every @code{tab-width} columns regardless of the contents of @code{tab-stop-list}. @xref{Text Display}. @node Just Spaces,, Tab Stops, Indentation @section Tabs vs. Spaces @vindex indent-tabs-mode Emacs normally uses both tabs and spaces to indent lines. If you prefer, all indentation can be made from spaces only. To request this, set @code{indent-tabs-mode} to @code{nil}. This is a per-buffer variable, so altering the variable affects only the current buffer, but there is a default value which you can change as well. @xref{Locals}. A tab is not always displayed in the same way. By default, tabs are eight columns wide, but some people like to customize their editors to use a different tab width (e.g., by changing the variable @code{tab-width} in Emacs). By using spaces only, you can make sure that your file looks the same regardless of the tab width setting. @findex tabify @findex untabify There are also commands to convert tabs to spaces or vice versa, always preserving the columns of all nonblank text. @kbd{M-x tabify} scans the region for sequences of spaces, and converts sequences of at least two spaces to tabs if that can be done without changing indentation. @kbd{M-x untabify} changes all tabs in the region to appropriate numbers of spaces. @ignore arch-tag: acc07de7-ae11-4ee8-a159-cb59c473f0fb @end ignore