annotate man/xemacs/indent.texi @ 2367:ecf1ebac70d8

[xemacs-hg @ 2004-11-04 23:05:23 by ben] commit mega-patch configure.in: Turn off -Winline and -Wchar-subscripts. Use the right set of cflags when compiling modules. Rewrite ldap configuration to separate the inclusion of lber (needed in recent Cygwin) from the basic checks for the needed libraries. add a function for MAKE_JUNK_C; initially code was added to generate xemacs.def using this, but it will need to be rewritten. add an rm -f for junk.c to avoid weird Cygwin bug with cp -f onto an existing file. Sort list of auto-detected functions and eliminate unused checks for stpcpy, setlocale and getwd. Add autodetection of Cygwin scanf problems BETA: Rewrite section on configure to indicate what flags are important and what not. digest-doc.c, make-dump-id.c, profile.c, sorted-doc.c: Add proper decls for main(). make-msgfile.c: Document that this is old junk. Move proposal to text.c. make-msgfile.lex: Move proposal to text.c. make-mswin-unicode.pl: Convert error-generating code so that the entire message will be seen as a single unrecognized token. mule/mule-ccl.el: Update docs. lispref/mule.texi: Update CCL docs. ldap/eldap.c: Mule-ize. Use EXTERNAL_LIST_LOOP_2 instead of deleted EXTERNAL_LIST_LOOP. * XEmacs 21.5.18 "chestnut" is released. --------------------------------------------------------------- MULE-RELATED WORK: --------------------------------------------------------------- --------------------------- byte-char conversion --------------------------- buffer.c, buffer.h, insdel.c, text.c: Port FSF algorithm for byte-char conversion, replacing broken previous version. Track the char position of the gap. Add functions to do char-byte conversion downwards as well as upwards. Move comments about algorithm workings to internals manual. --------------------------- work on types --------------------------- alloc.c, console-x-impl.h, dump-data.c, dump-data.h, dumper.c, dialog-msw.c, dired-msw.c, doc.c, editfns.c, esd.c, event-gtk.h, event-msw.c, events.c, file-coding.c, file-coding.h, fns.c, glyphs-eimage.c, glyphs-gtk.c, glyphs-msw.c, glyphs-shared.c, glyphs-x.c, glyphs.c, glyphs.h, gui.c, hpplay.c, imgproc.c, intl-win32.c, lrecord.h, lstream.c, keymap.c, lisp.h, libsst.c, linuxplay.c, miscplay.c, miscplay.h, mule-coding.c, nas.c, nt.c, ntheap.c, ntplay.c, objects-msw.c, objects-tty.c, objects-x.c, print.c, process-nt.c, process.c, redisplay.h, select-common.h, select-gtk.c, select-x.c, sgiplay.c, sound.c, sound.h, sunplay.c, sysfile.h, sysdep.c, syswindows.h, text.c, unexnt.c, win32.c, xgccache.c: Further work on types. This creates a full set of types for all the basic semantics of `char' that I have so far identified, so that its semantics can always be identified for the purposes of proper Mule-safe code, and the raw use of `char' always avoided. (1) More type renaming, for consistency of naming. Char_ASCII -> Ascbyte UChar_ASCII -> UAscbyte Char_Binary -> CBinbyte UChar_Binary -> Binbyte SChar_Binary -> SBinbyte (2) Introduce Rawbyte, CRawbyte, Boolbyte, Chbyte, UChbyte, and Bitbyte and use them. (3) New types Itext, Wexttext and Textcount for separating out the concepts of bytes and textual units (different under UTF-16 and UTF-32, which are potential internal encodings). (4) qxestr*_c -> qxestr*_ascii. lisp.h: New; goes with other qxe() functions. #### Maybe goes in a different section. lisp.h: Group generic int-type defs together with EMACS_INT defs. lisp.h: * lisp.h (WEXTTEXT_IS_WIDE) New defns. lisp.h: New type to replace places where int occurs as a boolean. It's signed because occasionally people may want to use -1 as an error value, and because unsigned ints are viral -- see comments in the internals manual against using them. dynarr.c: int -> Bytecount. --------------------------- Mule-izing --------------------------- device-x.c: Partially Mule-ize. dumper.c, dumper.h: Mule-ize. Use Rawbyte. Use stderr_out not printf. Use wext_*(). sysdep.c, syswindows.h, text.c: New Wexttext API for manipulation of external text that may be Unicode (e.g. startup code under Windows). emacs.c: Mule-ize. Properly deal with argv in external encoding. Use wext_*() and Wexttext. Use Rawbyte. #if 0 some old junk on SCO that is unlikely to be correct. Rewrite allocation code in run-temacs. emacs.c, symsinit.h, win32.c: Rename win32 init function and call it even earlier, to initialize mswindows_9x_p even earlier, for use in startup code (XEUNICODE_P). process.c: Use _wenviron not environ under Windows, to get Unicode environment variables. event-Xt.c: Mule-ize drag-n-drop related stuff. dragdrop.c, dragdrop.h, frame-x.c: Mule-ize. text.h: Add some more stand-in defines for particular kinds of conversion; use in Mule-ization work in frame-x.c etc. --------------------------- Freshening --------------------------- intl-auto-encap-win32.c, intl-auto-encap-win32.h: Regenerate. --------------------------- Unicode-work --------------------------- intl-win32.c, syswindows.h: Factor out common options to MultiByteToWideChar and WideCharToMultiByte. Add convert_unicode_to_multibyte_malloc() and convert_unicode_to_multibyte_dynarr() and use. Add stuff for alloca() conversion of multibyte/unicode. alloc.c: Use dfc_external_data_len() in case of unicode coding system. alloc.c, mule-charset.c: Don't zero out and reinit charset Unicode tables. This fucks up dump-time loading. Anyway, either we load them at dump time or run time, never both. unicode.c: Dump the blank tables as well. --------------------------------------------------------------- DOCUMENTATION, MOSTLY MULE-RELATED: --------------------------------------------------------------- EmacsFrame.c, emodules.c, event-Xt.c, fileio.c, input-method-xlib.c, mule-wnnfns.c, redisplay-gtk.c, redisplay-tty.c, redisplay-x.c, regex.c, sysdep.c: Add comment about Mule work needed. text.h: Add more documentation describing why DFC routines were not written to return their value. Add some other DFC documentation. console-msw.c, console-msw.h: Add pointer to docs in win32.c. emacs.c: Add comments on sources of doc info. text.c, charset.h, unicode.c, intl-win32.c, intl-encap-win32.c, text.h, file-coding.c, mule-coding.c: Collect background comments and related to text matters and internationalization, and proposals for work to be done, in text.c or Internals manual, stuff related to specific textual API's in text.h, and stuff related to internal implementation of Unicode conversion in unicode.c. Put lots of pointers to the comments to make them easier to find. s/mingw32.h, s/win32-common.h, s/win32-native.h, s/windowsnt.h, win32.c: Add bunches of new documentation on the different kinds of builds and environments under Windows and how they work. Collect this info in win32.c. Add pointers to these docs in the relevant s/* files. emacs.c: Document places with long comments. Remove comment about exiting, move to internals manual, put in pointer. event-stream.c: Move docs about event queues and focus to internals manual, put in pointer. events.h: Move docs about event stream callbacks to internals manual, put in pointer. profile.c, redisplay.c, signal.c: Move documentation to the Internals manual. process-nt.c: Add pointer to comment in win32-native.el. lisp.h: Add comments about some comment conventions. lisp.h: Add comment about the second argument. device-msw.c, redisplay-msw.c: @@#### comments are out-of-date. --------------------------------------------------------------- PDUMP WORK (MOTIVATED BY UNICODE CHANGES) --------------------------------------------------------------- alloc.c, buffer.c, bytecode.c, console-impl.h, console.c, device.c, dumper.c, lrecord.h, elhash.c, emodules.h, events.c, extents.c, frame.c, glyphs.c, glyphs.h, mule-charset.c, mule-coding.c, objects.c, profile.c, rangetab.c, redisplay.c, specifier.c, specifier.h, window.c, lstream.c, file-coding.h, file-coding.c: PDUMP: Properly implement dump_add_root_block(), which never worked before, and is necessary for dumping Unicode tables. Pdump name changes for accuracy: XD_STRUCT_PTR -> XD_BLOCK_PTR. XD_STRUCT_ARRAY -> XD_BLOCK_ARRAY. XD_C_STRING -> XD_ASCII_STRING. *_structure_* -> *_block_*. lrecord.h: some comments added about dump_add_root_block() vs dump_add_root_block_ptr(). extents.c: remove incorrect comment about pdump problems with gap array. --------------------------------------------------------------- ALLOCATION --------------------------------------------------------------- abbrev.c, alloc.c, bytecode.c, casefiddle.c, device-msw.c, device-x.c, dired-msw.c, doc.c, doprnt.c, dragdrop.c, editfns.c, emodules.c, file-coding.c, fileio.c, filelock.c, fns.c, glyphs-eimage.c, glyphs-gtk.c, glyphs-msw.c, glyphs-x.c, gui-msw.c, gui-x.c, imgproc.c, intl-win32.c, lread.c, menubar-gtk.c, menubar.c, nt.c, objects-msw.c, objects-x.c, print.c, process-nt.c, process-unix.c, process.c, realpath.c, redisplay.c, search.c, select-common.c, symbols.c, sysdep.c, syswindows.h, text.c, text.h, ui-byhand.c: New macros {alloca,xnew}_{itext,{i,ext,raw,bin,asc}bytes} for more convenient allocation of these commonly requested items. Modify functions to use alloca_ibytes, alloca_array, alloca_extbytes, xnew_ibytes, etc. also XREALLOC_ARRAY, xnew. alloc.c: Rewrite the allocation functions to factor out repeated code. Add assertions for freeing dumped data. lisp.h: Moved down and consolidated with other allocation stuff. lisp.h, dynarr.c: New functions for allocation that's very efficient when mostly in LIFO order. lisp.h, text.c, text.h: Factor out some stuff for general use by alloca()-conversion funs. text.h, lisp.h: Fill out convenience routines for allocating various kinds of bytes and put them in lisp.h. Use them in place of xmalloc(), ALLOCA(). text.h: Fill out the convenience functions so the _MALLOC() kinds match the alloca() kinds. --------------------------------------------------------------- ERROR-CHECKING --------------------------------------------------------------- text.h: Create ASSERT_ASCTEXT_ASCII() and ASSERT_ASCTEXT_ASCII_LEN() from similar Eistring checkers and change the Eistring checkers to use them instead. --------------------------------------------------------------- MACROS IN LISP.H --------------------------------------------------------------- lisp.h: Redo GCPRO declarations. Create a "base" set of functions that can be used to generate any kind of gcpro sets -- regular, ngcpro, nngcpro, private ones used in GC_EXTERNAL_LIST_LOOP_2. buffer.c, callint.c, chartab.c, console-msw.c, device-x.c, dialog-msw.c, dired.c, extents.c, ui-gtk.c, rangetab.c, nt.c, mule-coding.c, minibuf.c, menubar-msw.c, menubar.c, menubar-gtk.c, lread.c, lisp.h, gutter.c, glyphs.c, glyphs-widget.c, fns.c, fileio.c, file-coding.c, specifier.c: Eliminate EXTERNAL_LIST_LOOP, which does not check for circularities. Use EXTERNAL_LIST_LOOP_2 instead or EXTERNAL_LIST_LOOP_3 or EXTERNAL_PROPERTY_LIST_LOOP_3 or GC_EXTERNAL_LIST_LOOP_2 (new macro). Removed/redid comments on EXTERNAL_LIST_LOOP. --------------------------------------------------------------- SPACING FIXES --------------------------------------------------------------- callint.c, hftctl.c, number-gmp.c, process-unix.c: Spacing fixes. --------------------------------------------------------------- FIX FOR GEOMETRY PROBLEM IN FIRST FRAME --------------------------------------------------------------- unicode.c: Add workaround for newlib bug in sscanf() [should be fixed by release 1.5.12 of Cygwin]. toolbar.c: bug fix for problem of initial frame being 77 chars wide on Windows. will be overridden by my other ws. --------------------------------------------------------------- FIX FOR LEAKING PROCESS HANDLES: --------------------------------------------------------------- process-nt.c: Fixes for leaking handles. Inspired by work done by Adrian Aichner <adrian@xemacs.org>. --------------------------------------------------------------- FIX FOR CYGWIN BUG (Unicode-related): --------------------------------------------------------------- unicode.c: Add workaround for newlib bug in sscanf() [should be fixed by release 1.5.12 of Cygwin]. --------------------------------------------------------------- WARNING FIXES: --------------------------------------------------------------- console-stream.c: `reinit' is unused. compiler.h, event-msw.c, frame-msw.c, intl-encap-win32.c, text.h: Add stuff to deal with ANSI-aliasing warnings I got. regex.c: Gather includes together to avoid warning. --------------------------------------------------------------- CHANGES TO INITIALIZATION ROUTINES: --------------------------------------------------------------- buffer.c, emacs.c, console.c, debug.c, device-x.c, device.c, dragdrop.c, emodules.c, eval.c, event-Xt.c, event-gtk.c, event-msw.c, event-stream.c, event-tty.c, events.c, extents.c, faces.c, file-coding.c, fileio.c, font-lock.c, frame-msw.c, glyphs-widget.c, glyphs.c, gui-x.c, insdel.c, lread.c, lstream.c, menubar-gtk.c, menubar-x.c, minibuf.c, mule-wnnfns.c, objects-msw.c, objects.c, print.c, scrollbar-x.c, search.c, select-x.c, text.c, undo.c, unicode.c, window.c, symsinit.h: Call reinit_*() functions directly from emacs.c, for clarity. Factor out some redundant init code. Move disallowed stuff that had crept into vars_of_glyphs() into complex_vars_of_glyphs(). Call init_eval_semi_early() from eval.c not in the middle of vars_of_() in emacs.c since there should be no order dependency in the latter calls. --------------------------------------------------------------- ARMAGEDDON: --------------------------------------------------------------- alloc.c, emacs.c, lisp.h, print.c: Rename inhibit_non_essential_printing_operations to inhibit_non_essential_conversion_operations. text.c: Assert on !inhibit_non_essential_conversion_operations. console-msw.c, print.c: Don't do conversion in SetConsoleTitle or FindWindow to avoid problems during armageddon. Put #errors for NON_ASCII_INTERNAL_FORMAT in places where problems would arise. --------------------------------------------------------------- CHANGES TO THE BUILD PROCEDURE: --------------------------------------------------------------- config.h.in, s/cxux.h, s/usg5-4-2.h, m/powerpc.h: Add comment about correct ordering of this file. Rearrange everything to follow this -- put all #undefs together and before the s&m files. Add undefs for HAVE_ALLOCA, C_ALLOCA, BROKEN_ALLOCA_IN_FUNCTION_CALLS, STACK_DIRECTION. Remove unused HAVE_STPCPY, HAVE_GETWD, HAVE_SETLOCALE. m/gec63.h: Deleted; totally broken, not used at all, not in FSF. m/7300.h, m/acorn.h, m/alliant-2800.h, m/alliant.h, m/altos.h, m/amdahl.h, m/apollo.h, m/att3b.h, m/aviion.h, m/celerity.h, m/clipper.h, m/cnvrgnt.h, m/convex.h, m/cydra5.h, m/delta.h, m/delta88k.h, m/dpx2.h, m/elxsi.h, m/ews4800r.h, m/gould.h, m/hp300bsd.h, m/hp800.h, m/hp9000s300.h, m/i860.h, m/ibmps2-aix.h, m/ibmrs6000.h, m/ibmrt-aix.h, m/ibmrt.h, m/intel386.h, m/iris4d.h, m/iris5d.h, m/iris6d.h, m/irist.h, m/isi-ov.h, m/luna88k.h, m/m68k.h, m/masscomp.h, m/mg1.h, m/mips-nec.h, m/mips-siemens.h, m/mips.h, m/news.h, m/nh3000.h, m/nh4000.h, m/ns32000.h, m/orion105.h, m/pfa50.h, m/plexus.h, m/pmax.h, m/powerpc.h, m/pyrmips.h, m/sequent-ptx.h, m/sequent.h, m/sgi-challenge.h, m/symmetry.h, m/tad68k.h, m/tahoe.h, m/targon31.h, m/tekxd88.h, m/template.h, m/tower32.h, m/tower32v3.h, m/ustation.h, m/vax.h, m/wicat.h, m/xps100.h: Delete C_ALLOCA, HAVE_ALLOCA, STACK_DIRECTION, BROKEN_ALLOCA_IN_FUNCTION_CALLS. All of this is auto-detected. When in doubt, I followed recent FSF sources, which also have these things deleted.
author ben
date Thu, 04 Nov 2004 23:08:28 +0000
parents 376386a54a3c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2 @node Indentation, Text, Major Modes, Top
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
3 @chapter Indentation
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
4 @cindex indentation
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6 @c WideCommands
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7 @table @kbd
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
8 @item @key{TAB}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
9 Indent current line ``appropriately'' in a mode-dependent fashion.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
10 @item @key{LFD}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11 Perform @key{RET} followed by @key{TAB} (@code{newline-and-indent}).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12 @item M-^
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
13 Merge two lines (@code{delete-indentation}). This would cancel out
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14 the effect of @key{LFD}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15 @item C-M-o
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16 Split line at point; text on the line after point becomes a new line
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17 indented to the same column that it now starts in (@code{split-line}).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18 @item M-m
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19 Move (forward or back) to the first non-blank character on the current
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20 line (@code{back-to-indentation}).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21 @item C-M-\
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22 Indent several lines to same column (@code{indent-region}).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23 @item C-x @key{TAB}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24 Shift block of lines rigidly right or left (@code{indent-rigidly}).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25 @item M-i
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26 Indent from point to the next prespecified tab stop column
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27 (@code{tab-to-tab-stop}).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28 @item M-x indent-relative
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29 Indent from point to under an indentation point in the previous line.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30 @end table
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32 @kindex TAB
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33 @cindex indentation
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34 Most programming languages have some indentation convention. For Lisp
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35 code, lines are indented according to their nesting in parentheses. The
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36 same general idea is used for C code, though details differ.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38 Use the @key{TAB} command to indent a line whatever the language.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39 Each major mode defines this command to perform indentation appropriate
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40 for the particular language. In Lisp mode, @key{TAB} aligns a line
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41 according to its depth in parentheses. No matter where in the line you
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42 are when you type @key{TAB}, it aligns the line as a whole. In C mode,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43 @key{TAB} implements a subtle and sophisticated indentation style that
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44 knows about many aspects of C syntax.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46 @kindex TAB
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47 In Text mode, @key{TAB} runs the command @code{tab-to-tab-stop}, which
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
48 indents to the next tab stop column. You can set the tab stops with
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
49 @kbd{M-x edit-tab-stops}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
50
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51 @menu
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52 * Indentation Commands:: Various commands and techniques for indentation.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
53 * Tab Stops:: You can set arbitrary "tab stops" and then
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
54 indent to the next tab stop when you want to.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55 * Just Spaces:: You can request indentation using just spaces.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
56 @end menu
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58 @node Indentation Commands, Tab Stops, Indentation, Indentation
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
59 @section Indentation Commands and Techniques
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
60 @c ??? Explain what Emacs has instead of space-indent-flag.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
61
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
62 If you just want to insert a tab character in the buffer, you can type
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
63 @kbd{C-q @key{TAB}}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
64
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
65 @kindex M-m
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66 @findex back-to-indentation
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
67 To move over the indentation on a line, type @kbd{Meta-m}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
68 (@code{back-to-indentation}). This command, given anywhere on a line,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
69 positions point at the first non-blank character on the line.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
70
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
71 To insert an indented line before the current line, type @kbd{C-a C-o
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
72 @key{TAB}}. To make an indented line after the current line, use
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
73 @kbd{C-e @key{LFD}}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
74
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
75 @kindex C-M-o
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
76 @findex split-line
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
77 @kbd{C-M-o} (@code{split-line}) moves the text from point to the end of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
78 the line vertically down, so that the current line becomes two lines.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
79 @kbd{C-M-o} first moves point forward over any spaces and tabs. Then it
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
80 inserts after point a newline and enough indentation to reach the same
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
81 column point is on. Point remains before the inserted newline; in this
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
82 regard, @kbd{C-M-o} resembles @kbd{C-o}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
83
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
84 @kindex M-\
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
85 @kindex M-^
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
86 @findex delete-horizontal-space
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
87 @findex delete-indentation
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
88 To join two lines cleanly, use the @kbd{Meta-^}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
89 (@code{delete-indentation}) command to delete the indentation at the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
90 front of the current line, and the line boundary as well. Empty spaces
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
91 are replaced by a single space, or by no space if at the beginning of a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
92 line, before a close parenthesis, or after an open parenthesis.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
93 To delete just the indentation of a line, go to the beginning of the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
94 line and use @kbd{Meta-\} (@code{delete-horizontal-space}), which
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
95 deletes all spaces and tabs around the cursor.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
96
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
97 @kindex C-M-\
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
98 @kindex C-x TAB
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
99 @findex indent-region
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
100 @findex indent-rigidly
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
101 There are also commands for changing the indentation of several lines at
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
102 once. @kbd{Control-Meta-\} (@code{indent-region}) gives each line which
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
103 begins in the region the ``usual'' indentation by invoking @key{TAB} at the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
104 beginning of the line. A numeric argument specifies the column to indent
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
105 to. Each line is shifted left or right so that its first non-blank
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
106 character appears in that column. @kbd{C-x @key{TAB}}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
107 (@code{indent-rigidly}) moves all the lines in the region right by its
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
108 argument (left, for negative arguments). The whole group of lines moves
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
109 rigidly sideways, which is how the command gets its name.@refill
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
110
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
111 @findex indent-relative
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
112 @kbd{M-x indent-relative} indents at point based on the previous line
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
113 (actually, the last non-empty line.) It inserts whitespace at point, moving
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
114 point, until it is underneath an indentation point in the previous line.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
115 An indentation point is the end of a sequence of whitespace or the end of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
116 the line. If point is farther right than any indentation point in the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
117 previous line, the whitespace before point is deleted and the first
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
118 indentation point then applicable is used. If no indentation point is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
119 applicable even then, @code{tab-to-tab-stop} is run (see next section).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
120
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
121 @code{indent-relative} is the definition of @key{TAB} in Indented Text
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
122 mode. @xref{Text}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
123
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
124 @node Tab Stops, Just Spaces, Indentation Commands, Indentation
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
125 @section Tab Stops
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
126
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
127 @kindex M-i
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
128 @findex tab-to-tab-stop
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
129 For typing in tables, you can use Text mode's definition of @key{TAB},
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
130 @code{tab-to-tab-stop}. This command inserts indentation before point,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
131 enough to reach the next tab stop column. Even if you are not in Text mode,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
132 this function is associated with @kbd{M-i} anyway.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
133
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
134 @findex edit-tab-stops
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
135 @findex edit-tab-stops-note-changes
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
136 @kindex C-c C-c (Edit Tab Stops)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
137 @vindex tab-stop-list
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
138 You can arbitrarily set the tab stops used by @kbd{M-i}. They are
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
139 stored as a list of column-numbers in increasing order in the variable
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
140 @code{tab-stop-list}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
141
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
142 The convenient way to set the tab stops is using @kbd{M-x edit-tab-stops},
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
143 which creates and selects a buffer containing a description of the tab stop
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
144 settings. You can edit this buffer to specify different tab stops, and
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
145 then type @kbd{C-c C-c} to make those new tab stops take effect. In the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
146 tab stop buffer, @kbd{C-c C-c} runs the function
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
147 @code{edit-tab-stops-note-changes} rather than the default
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
148 @code{save-buffer}. @code{edit-tab-stops} records which buffer was current
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
149 when you invoked it, and stores the tab stops in that buffer. Normally
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
150 all buffers share the same tab stops and changing them in one buffer
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
151 affects all. If you make @code{tab-stop-list} local in one
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
152 buffer @code{edit-tab-stops} in that buffer edits only the local
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
153 settings.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
154
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
155 Below is the text representing ordinary tab stops every eight columns:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
156
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
157 @example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
158 : : : : : :
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
159 0 1 2 3 4
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
160 0123456789012345678901234567890123456789012345678
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
161 To install changes, type C-c C-c
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
162 @end example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
163
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
164 The first line contains a colon at each tab stop. The remaining lines
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
165 help you see where the colons are and tell you what to do.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
166
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
167 Note that the tab stops that control @code{tab-to-tab-stop} have nothing
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
168 to do with displaying tab characters in the buffer. @xref{Display Vars},
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
169 for more information on that.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
170
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
171 @node Just Spaces,, Tab Stops, Indentation
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
172 @section Tabs vs. Spaces
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
173
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
174 @vindex indent-tabs-mode
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
175 Emacs normally uses both tabs and spaces to indent lines. If you prefer,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
176 all indentation can be made from spaces only. To request this, set
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
177 @code{indent-tabs-mode} to @code{nil}. This is a per-buffer variable;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
178 altering the variable affects only the current buffer, but there is a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
179 default value which you can change as well. @xref{Locals}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
180
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
181 @findex tabify
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
182 @findex untabify
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
183 There are also commands to convert tabs to spaces or vice versa, always
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
184 preserving the columns of all non-blank text. @kbd{M-x tabify} scans the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
185 region for sequences of spaces, and converts sequences of at least three
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
186 spaces to tabs if that is possible without changing indentation. @kbd{M-x
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
187 untabify} changes all tabs in the region to corresponding numbers of spaces.