annotate doc/misc/autotype.texi @ 87359:124f61e76b1a

(Keywords): Not keywords.
author Alex Schroeder <alex@gnu.org>
date Fri, 21 Dec 2007 11:41:20 +0000
parents 3d431f1997d8
children 5d58981e6690
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
84284
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1 \input texinfo
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2 @c This is an annex of the Emacs manual.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3 @c Copyright (C) 1994, 1995, 2001, 2002, 2003, 2004,
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4 @c 2005, 2006, 2007 Free Software Foundation, Inc.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5 @c Author: Daniel.Pfeiffer@Informatik.START.dbp.de, fax (+49 69) 7588-2389
84329
3d431f1997d8 (setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents: 84284
diff changeset
6 @setfilename ../../info/autotype
84284
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7 @c @node Autotypist, Picture, Abbrevs, Top
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8 @c @chapter Features for Automatic Typing
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9 @settitle Features for Automatic Typing
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10 @c @cindex text
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11 @c @cindex selfinserting text
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12 @c @cindex autotypist
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14 @copying
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15 Copyright @copyright{} 1994, 1995, 1999, 2001, 2002, 2003, 2004,
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16 2005, 2006, 2007 Free Software Foundation, Inc.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18 @quotation
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19 Permission is granted to copy, distribute and/or modify this document
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20 under the terms of the GNU Free Documentation License, Version 1.2 or
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21 any later version published by the Free Software Foundation; with the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22 Invariant Sections being ``The GNU Manifesto'', ``Distribution'' and
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
23 ``GNU GENERAL PUBLIC LICENSE'', with the Front-Cover texts being ``A GNU
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
24 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
25 license is included in the section entitled ``GNU Free Documentation
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
26 License'' in the Emacs manual.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
27
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
28 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
29 this GNU Manual, like GNU software. Copies published by the Free
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
30 Software Foundation raise funds for GNU development.''
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
31
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
32 This document is part of a collection distributed under the GNU Free
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
33 Documentation License. If you want to distribute this document
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
34 separately from the collection, you can do so by adding a copy of the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
35 license to the document, as described in section 6 of the license.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
36 @end quotation
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
37 @end copying
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
38
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
39 @dircategory Emacs
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
40 @direntry
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
41 * Autotype: (autotype). Convenient features for text that you enter frequently
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
42 in Emacs.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
43 @end direntry
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
44
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
45 @titlepage
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
46 @sp 10
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
47
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
48 @center @titlefont{Autotyping}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
49 @sp 2
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
50 @center @subtitlefont{Convenient features for text that you enter
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
51 frequently in Emacs}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
52 @sp 2
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
53 @center Daniel Pfeiffer
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
54 @center additions by Dave Love
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
55
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
56 @page
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
57 @vskip 0pt plus 1filll
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
58 @insertcopying
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
59 @end titlepage
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
60
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
61 @node Top
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
62 @top Autotyping
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
63
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
64 Under certain circumstances you will find yourself typing similar things
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
65 over and over again. This is especially true of form letters and programming
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
66 language constructs. Project-specific header comments, flow-control
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
67 constructs or magic numbers are essentially the same every time. Emacs has
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
68 various features for doing tedious and repetitive typing chores for you
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
69 in addition to the Abbrev features (@pxref{(emacs)Abbrevs}).
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
70
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
71 One solution is using skeletons, flexible rules that say what to
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
72 insert, and how to do it. Various programming language modes offer some
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
73 ready-to-use skeletons, and you can adapt them to suit your needs or
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
74 taste, or define new ones.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
75
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
76 Another feature is automatic insertion of what you want into empty files,
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
77 depending on the file-name or the mode as appropriate. You can have a file or
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
78 a skeleton inserted, or you can call a function. Then there is the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
79 possibility to have Un*x interpreter scripts automatically take on a magic
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
80 number and be executable as soon as they are saved. Or you can have a
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
81 copyright notice's year updated, if necessary, every time you save a
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
82 file. Similarly for time stamps in the file.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
83
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
84 URLs can be inserted based on a word at point. Flexible templates can
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
85 be defined for inserting and navigating between text more generally. A
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
86 sort of meta-expansion facility can be used to try a set of alternative
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
87 completions and expansions of text at point.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
88
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
89 @menu
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
90 * Using Skeletons:: How to insert a skeleton into your text.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
91 * Wrapping Skeletons:: Putting existing text within a skeleton.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
92 * Skeletons as Abbrevs:: An alternative for issuing skeleton commands.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
93 * Skeleton Language:: Making skeleton commands insert what you want.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
94 * Inserting Pairs:: Typing one character and getting another
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
95 after point.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
96 * Autoinserting:: Filling up empty files as soon as you visit them.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
97 * Copyrights:: Inserting and updating copyrights.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
98 * Executables:: Turning interpreter scripts into executables.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
99 * Timestamps:: Updating dates and times in modified files.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
100 * QuickURL:: Inserting URLs based on text at point.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
101 * Tempo:: Flexible template insertion.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
102 * Hippie Expand:: Expansion of text trying various methods.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
103
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
104 * GNU Free Documentation License:: The license for this documentation.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
105 * Concept Index::
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
106 * Command Index::
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
107 * Variable Index::
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
108 @end menu
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
109
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
110
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
111
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
112 @node Using Skeletons
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
113 @chapter Using Skeletons
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
114 @cindex skeletons
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
115 @cindex using skeletons
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
116
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
117 When you want Emacs to insert a form letter or a typical construct of the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
118 programming language you are using, skeletons are a means of accomplishing
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
119 this. Normally skeletons each have a command of their own, that, when called,
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
120 will insert the skeleton. These commands can be issued in the usual ways
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
121 (@pxref{(emacs)Commands}). Modes that offer various skeletons will often
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
122 bind these to key-sequences on the @kbd{C-c} prefix, as well as having
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
123 an @cite{Insert} menu and maybe even predefined abbrevs for them
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
124 (@pxref{Skeletons as Abbrevs}).
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
125
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
126 The simplest kind of skeleton will simply insert some text indented
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
127 according to the major mode and leave the cursor at a likely place in the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
128 middle. Interactive skeletons may prompt you for a string that will be part
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
129 of the inserted text.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
130
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
131 Skeletons may ask for input several times. They even have a looping
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
132 mechanism in which you will be asked for input as long as you are willing to
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
133 furnish it. An example would be multiple ``else if'' conditions. You can
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
134 recognize this situation by a prompt ending in @key{RET}, @kbd{C-g}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
135 or @kbd{C-h}. This
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
136 means that entering an empty string will simply assume that you are finished.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
137 Typing quit on the other hand terminates the loop but also the rest of the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
138 skeleton, e.g. an ``else'' clause is skipped. Only a syntactically necessary
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
139 termination still gets inserted.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
140
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
141
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
142
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
143 @node Wrapping Skeletons
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
144 @chapter Wrapping Skeletons Around Existing Text
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
145 @cindex wrapping skeletons
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
146
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
147 Often you will find yourself with some code that for whatever reason
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
148 suddenly becomes conditional. Or you have written a bit of text and want to
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
149 put it in the middle of a form letter. Skeletons provide a means for
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
150 accomplishing this, and can even, in the case of programming languages,
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
151 reindent the wrapped code for you.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
152
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
153 Skeleton commands take an optional numeric prefix argument
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
154 (@pxref{(emacs)Arguments}). This is interpreted in two different ways depending
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
155 on whether the prefix is positive, i.e. forwards oriented or negative,
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
156 i.e. backwards oriented.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
157
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
158 A positive prefix means to wrap the skeleton around that many
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
159 following words. This is accomplished by putting the words there where
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
160 the point is normally left after that skeleton is inserted (@pxref{Using
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
161 Skeletons}). The point (@pxref{(emacs)Point}) is left at the next
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
162 interesting spot in the skeleton instead.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
163
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
164 A negative prefix means to do something similar with that many precedingly
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
165 marked interregions (@pxref{(emacs)Mark}). In the simplest case, if you type
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
166 @kbd{M--} just before issuing the skeleton command, that will wrap the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
167 skeleton around the current region, just like a positive argument would have
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
168 wrapped it around a number of words.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
169
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
170 Smaller negative arguments will wrap that many interregions into successive
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
171 interesting spots within the skeleton, again leaving the point at the next one.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
172 We speak about interregions rather than regions here, because we treat them in
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
173 the order they appear in the buffer, which coincides with successive regions
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
174 only if they were marked in order.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
175
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
176 That is, if you marked in alphabetical order the points A B C [] (where []
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
177 represents the point) and call a skeleton command with @kbd{M-- 3}, you will
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
178 wrap the text from A to B into the first interesting spot of the skeleton, the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
179 text from B to C into the next one, the text from C to the point into the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
180 third one, and leave the point in the fourth one. If there are less marks in
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
181 the buffer, or if the skeleton defines less interesting points, the surplus is
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
182 ignored.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
183
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
184 If, on the other hand, you marked in alphabetical order the points [] A C B,
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
185 and call a skeleton command with @kbd{M-- 3}, you will wrap the text from
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
186 point to A, then the text from A to C and finally the text from C to B. This
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
187 is done because the regions overlap and Emacs would be helplessly lost if it
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
188 tried to follow the order in which you marked these points.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
189
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
190
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
191
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
192 @node Skeletons as Abbrevs
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
193 @chapter Skeletons as Abbrev Expansions
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
194 @cindex skeletons as abbrevs
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
195
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
196 Rather than use a key binding for every skeleton command, you can also
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
197 define an abbreviation (@pxref{(emacs)Defining Abbrevs}) that will expand
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
198 (@pxref{(emacs)Expanding Abbrevs}) into the skeleton.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
199
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
200 Say you want @samp{ifst} to be an abbreviation for the C language if
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
201 statement. You will tell Emacs that @samp{ifst} expands to the empty string
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
202 and then calls the skeleton command. In Emacs Lisp you can say something like
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
203 @code{(define-abbrev c-mode-abbrev-table "ifst" "" 'c-if)}. Or you can edit
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
204 the output from @kbd{M-x list-abbrevs} to make it look like this:
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
205
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
206 @example
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
207 (c-mode-abbrev-table)
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
208 "if" 0 "" c-if
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
209 @end example
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
210
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
211 @noindent
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
212 (Some blank lines of no semantic significance, and other abbrev tables,
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
213 have been omitted.)
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
214
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
215
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
216
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
217 @node Skeleton Language
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
218 @chapter Skeleton Language
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
219 @cindex skeleton language
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
220
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
221 @findex skeleton-insert
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
222 Skeletons are an shorthand extension to the Lisp language, where various
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
223 atoms directly perform either actions on the current buffer or rudimentary
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
224 flow control mechanisms. Skeletons are interpreted by the function
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
225 @code{skeleton-insert}.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
226
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
227 A skeleton is a list starting with an interactor, which is usually a
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
228 prompt-string, or @code{nil} when not needed, but can also be a Lisp
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
229 expression for complex read functions or for returning some calculated value.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
230 The rest of the list are any number of elements as described in the following
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
231 table:
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
232
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
233 @table @asis
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
234 @item @code{"@var{string}"}, @code{?@var{c}}, @code{?\@var{c}}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
235 @vindex skeleton-transformation
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
236 Insert string or character. Literal strings and characters are passed through
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
237 @code{skeleton-transformation} when that is non-@code{nil}.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
238 @item @code{?\n}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
239 @c ??? something seems very wrong here.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
240 Insert a newline and align under current line. Use newline character
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
241 @code{?\n} to prevent alignment.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
242 @item @code{_}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
243 Interesting point. When wrapping skeletons around successive regions, they are
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
244 put at these places. Point is left at first @code{_} where nothing is wrapped.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
245 @item @code{>}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
246 Indent line according to major mode. When following element is @code{_}, and
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
247 there is a interregion that will be wrapped here, indent that interregion.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
248 @item @code{&}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
249 Logical and. Iff preceding element moved point, i.e. usually inserted
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
250 something, do following element.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
251 @item @code{|}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
252 Logical xor. Iff preceding element didn't move point, i.e. usually inserted
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
253 nothing, do following element.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
254 @item @code{-@var{number}}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
255 Delete preceding number characters. Depends on value of
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
256 @code{skeleton-untabify}.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
257 @item @code{()} or @code{nil}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
258 Ignored.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
259 @item @var{lisp-expression}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
260 Evaluated, and the return value is again interpreted as a skeleton element.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
261 @item @code{str}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
262 A special variable that, when evaluated the first time, usually prompts
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
263 for input according to the skeleton's interactor. It is then set to the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
264 return value resulting from the interactor. Each subskeleton has its local
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
265 copy of this variable.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
266 @item @code{v1}, @code{v2}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
267 Skeleton-local user variables.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
268 @item @code{'@var{expression}}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
269 Evaluate following Lisp expression for its side-effect, but prevent it from
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
270 being interpreted as a skeleton element.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
271 @item @var{skeleton}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
272 Subskeletons are inserted recursively, not once, but as often as the user
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
273 enters something at the subskeletons interactor. Thus there must be a
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
274 @code{str} in the subskeleton. They can also be used non-interactively, when
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
275 prompt is a lisp-expression that returns successive list-elements.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
276 @item @code{resume:}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
277 Ignored. Execution resumes here if the user quits during skeleton
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
278 interpretation.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
279 @item @code{quit}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
280 A constant which is non-@code{nil} when the @code{resume:} section was entered
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
281 because the user quit.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
282 @end table
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
283
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
284 @findex skeleton-further-elements
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
285 Some modes also use other skeleton elements they themselves defined. For
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
286 example in shell script mode's skeletons you will find @code{<} which does a
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
287 rigid indentation backwards, or in CC mode's skeletons you find the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
288 self-inserting elements @code{@{} and @code{@}}. These are defined by the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
289 buffer-local variable @code{skeleton-further-elements} which is a list of
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
290 variables bound while interpreting a skeleton.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
291
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
292 @findex define-skeleton
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
293 The macro @code{define-skeleton} defines a command for interpreting a
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
294 skeleton. The first argument is the command name, the second is a
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
295 documentation string, and the rest is an interactor and any number of skeleton
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
296 elements together forming a skeleton. This skeleton is assigned to a variable
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
297 of the same name as the command and can thus be overridden from your
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
298 @file{~/.emacs} file (@pxref{(emacs)Init File}).
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
299
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
300
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
301
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
302 @node Inserting Pairs
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
303 @chapter Inserting Matching Pairs of Characters
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
304 @cindex inserting pairs
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
305 @cindex pairs
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
306
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
307 Various characters usually appear in pairs. When, for example, you insert
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
308 an open parenthesis, no matter whether you are programming or writing prose,
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
309 you will surely enter a closing one later. By entering both at the same time
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
310 and leaving the cursor inbetween, Emacs can guarantee you that such
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
311 parentheses are always balanced. And if you have a non-qwerty keyboard, where
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
312 typing some of the stranger programming language symbols makes you bend your
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
313 fingers backwards, this can be quite relieving too.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
314
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
315 @findex skeleton-pair-insert-maybe
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
316 @vindex skeleton-pair
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
317 This is done by binding the first key (@pxref{(emacs)Rebinding}) of
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
318 the pair to @code{skeleton-pair-insert-maybe} instead of
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
319 @code{self-insert-command}. The ``maybe'' comes from the fact that
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
320 this at-first surprising behavior is initially turned off. To enable
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
321 it, you must set @code{skeleton-pair} to some non-@code{nil} value.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
322 And even then, a positive argument (@pxref{(emacs)Arguments}) will
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
323 make this key behave like a self-inserting key
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
324 (@pxref{(emacs)Inserting Text}).
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
325
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
326 @vindex skeleton-pair-on-word
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
327 While this breaks with the stated intention of always balancing pairs, it
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
328 turns out that one often doesn't want pairing to occur, when the following
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
329 character is part of a word. If you want pairing to occur even then, set
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
330 @code{skeleton-pair-on-word} to some non-@code{nil} value.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
331
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
332 @vindex skeleton-pair-alist
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
333 Pairing is possible for all visible characters. By default the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
334 parenthesis @samp{(}, the square bracket @samp{[}, the brace
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
335 @samp{@{}, the pointed bracket @samp{<} and the backquote @samp{`} all
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
336 pair with the symmetrical character. All other characters pair
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
337 themselves. This behavior can be modified by the variable
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
338 @code{skeleton-pair-alist}. This is in fact an alist of skeletons
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
339 (@pxref{Skeleton Language}), with the first part of each sublist
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
340 matching the typed character. This is the position of the interactor,
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
341 but since pairs don't need the @code{str} element, this is ignored.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
342
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
343 Some modes have bound the command @code{skeleton-pair-insert-maybe}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
344 to relevant keys. These modes also configure the pairs as
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
345 appropriate. For example, when typing english prose, you'd expect the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
346 backquote (@samp{`}) to pair with the quote (@samp{'}), while in Shell
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
347 script mode it must pair to itself. They can also inhibit pairing in
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
348 certain contexts. For example an escaped character stands for itself.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
349
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
350
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
351
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
352 @node Autoinserting
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
353 @chapter Autoinserting Text in Empty Files
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
354 @cindex autoinserting
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
355
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
356 @findex auto-insert
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
357 @kbd{M-x auto-insert} will put some predefined text at the beginning of
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
358 the buffer. The main application for this function, as its name suggests,
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
359 is to have it be called automatically every time an empty, and only an
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
360 empty file is visited. This is accomplished by putting @code{(add-hook
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
361 'find-file-hook 'auto-insert)} into your @file{~/.emacs} file
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
362 (@pxref{(emacs)Init File}).
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
363
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
364 @vindex auto-insert-alist
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
365 What gets inserted, if anything, is determined by the variable
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
366 @code{auto-insert-alist}. The @sc{car}s of this list are each either
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
367 a mode name, making an element applicable when a buffer is in that
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
368 mode. Or they can be a string, which is a regexp matched against the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
369 buffer's file name. In that way different kinds of files that have
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
370 the same mode in Emacs can be distinguished. The @sc{car}s may also
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
371 be cons cells consisting of mode name or regexp as above and an
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
372 additional descriptive string.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
373
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
374 When a matching element is found, the @sc{cdr} says what to do. It may
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
375 be a string, which is a file name, whose contents are to be inserted, if
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
376 that file is found in the directory @code{auto-insert-directory} or under a
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
377 absolute file name. Or it can be a skeleton (@pxref{Skeleton Language}) to
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
378 be inserted.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
379
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
380 It can also be a function, which allows doing various things. The function
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
381 can simply insert some text, indeed, it can be skeleton command (@pxref{Using
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
382 Skeletons}). It can be a lambda function which will for example conditionally
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
383 call another function. Or it can even reset the mode for the buffer. If you
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
384 want to perform several such actions in order, you use a vector, i.e. several
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
385 of the above elements between square brackets (@samp{[@r{@dots{}}]}).
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
386
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
387 By default C and C++ headers insert a definition of a symbol derived from
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
388 the filename to prevent multiple inclusions. C and C++ sources insert an
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
389 include of the header. Makefiles insert the file makefile.inc if it exists.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
390
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
391 TeX and bibTeX mode files insert the file tex-insert.tex if it exists, while
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
392 LaTeX mode files insert a typical @code{\documentclass} frame. Html
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
393 files insert a skeleton with the usual frame.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
394
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
395 Ada mode files call the Ada header skeleton command. Emacs lisp
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
396 source files insert the usual header, with a copyright of your
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
397 environment variable @env{$ORGANIZATION} or else the FSF, and prompt
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
398 for valid keywords describing the contents. Files in a @file{bin}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
399 directory for which Emacs could determine no specialized mode
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
400 (@pxref{(emacs)Choosing Modes}) are set to Shell script mode.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
401
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
402 @findex define-auto-insert
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
403 In Lisp (@pxref{(emacs)Init File}) you can use the function
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
404 @code{define-auto-insert} to add to or modify
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
405 @code{auto-insert-alist}. See its documentation with @kbd{C-h f
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
406 define-auto-insert}.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
407
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
408 @vindex auto-insert
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
409 The variable @code{auto-insert} says what to do when @code{auto-insert} is
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
410 called non-interactively, e.g. when a newly found file is empty (see above):
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
411 @table @asis
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
412 @item @code{nil}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
413 Do nothing.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
414 @item @code{t}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
415 Insert something if possible, i.e. there is a matching entry in
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
416 @code{auto-insert-alist}.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
417 @item other
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
418 Insert something if possible, but mark as unmodified.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
419 @end table
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
420
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
421 @vindex auto-insert-query
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
422 The variable @code{auto-insert-query} controls whether to ask about
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
423 inserting something. When this is @code{nil}, inserting is only done with
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
424 @kbd{M-x auto-insert}. When this is @code{function}, you are queried
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
425 whenever @code{auto-insert} is called as a function, such as when Emacs
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
426 visits an empty file and you have set the above-mentioned hook. Otherwise
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
427 you are alway queried.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
428
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
429 @vindex auto-insert-prompt
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
430 When querying, the variable @code{auto-insert-prompt}'s value is used as a
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
431 prompt for a y-or-n-type question. If this includes a @samp{%s} construct,
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
432 that is replaced by what caused the insertion rule to be chosen. This is
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
433 either a descriptive text, the mode-name of the buffer or the regular
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
434 expression that matched the filename.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
435
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
436
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
437
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
438 @node Copyrights
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
439 @chapter Inserting and Updating Copyrights
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
440 @cindex copyrights
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
441
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
442 @findex copyright
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
443 @kbd{M-x copyright} is a skeleton inserting command, that adds a copyright
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
444 notice at the point. The ``by'' part is taken from your environment variable
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
445 @env{$ORGANIZATION} or if that isn't set you are prompted for it. If the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
446 buffer has a comment syntax (@pxref{(emacs)Comments}), this is inserted as a comment.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
447
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
448 @findex copyright-update
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
449 @vindex copyright-limit
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
450 @vindex copyright-current-year
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
451 @kbd{M-x copyright-update} looks for a copyright notice in the first
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
452 @code{copyright-limit} characters of the buffer and updates it when necessary.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
453 The current year (variable @code{copyright-current-year}) is added to the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
454 existing ones, in the same format as the preceding year, i.e. 1994, '94 or 94.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
455 If a dash-separated year list up to last year is found, that is extended to
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
456 current year, else the year is added separated by a comma. Or it replaces
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
457 them when this is called with a prefix argument. If a header referring to a
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
458 wrong version of the GNU General Public License (@pxref{(emacs)Copying}) is found,
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
459 that is updated too.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
460
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
461 An interesting application for this function is to have it be called
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
462 automatically every time a file is saved. This is accomplished by
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
463 putting @code{(add-hook 'before-save-hook 'copyright-update)} into
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
464 your @file{~/.emacs} file (@pxref{(emacs)Init File}). Alternative,
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
465 you can do @kbd{M-x customize-variable @key{RET} before-save-hook
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
466 @key{RET}}. @code{copyright-update} is conveniently listed as an
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
467 option in the customization buffer.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
468
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
469 @vindex copyright-query
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
470 The variable @code{copyright-query} controls whether to update the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
471 copyright or whether to ask about it. When this is @code{nil} updating is
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
472 only done with @kbd{M-x copyright-update}. When this is @code{function}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
473 you are queried whenever @code{copyright-update} is called as a function,
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
474 such as in the @code{before-save-hook} feature mentioned above. Otherwise
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
475 you are always queried.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
476
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
477
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
478
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
479 @node Executables
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
480 @chapter Making Interpreter Scripts Executable
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
481 @cindex executables
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
482
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
483 @vindex executable-prefix
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
484 @vindex executable-chmod
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
485 Various interpreter modes such as Shell script mode or AWK mode will
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
486 automatically insert or update the buffer's magic number, a special
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
487 comment on the first line that makes the @code{exec} systemcall know
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
488 how to execute the script. To this end the script is automatically
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
489 made executable upon saving, with @code{executable-chmod} as argument
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
490 to the system @code{chmod} command. The magic number is prefixed by
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
491 the value of @code{executable-prefix}.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
492
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
493 @vindex executable-magicless-file-regexp
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
494 Any file whose name matches @code{executable-magicless-file-regexp} is not
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
495 furnished with a magic number, nor is it made executable. This is mainly
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
496 intended for resource files, which are only meant to be read in.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
497
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
498 @vindex executable-insert
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
499 The variable @code{executable-insert} says what to do when
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
500 @code{executable-set-magic} is called non-interactively, e.g. when file has no
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
501 or the wrong magic number:
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
502 @table @asis
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
503 @item @code{nil}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
504 Do nothing.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
505 @item @code{t}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
506 Insert or update magic number.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
507 @item other
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
508 Insert or update magic number, but mark as unmodified.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
509 @end table
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
510
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
511 @findex executable-set-magic
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
512 @vindex executable-query
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
513 The variable @code{executable-query} controls whether to ask about
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
514 inserting or updating the magic number. When this is @code{nil} updating
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
515 is only done with @kbd{M-x executable-set-magic}. When this is
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
516 @code{function} you are queried whenever @code{executable-set-magic} is
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
517 called as a function, such as when Emacs puts a buffer in Shell script
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
518 mode. Otherwise you are alway queried.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
519
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
520 @findex executable-self-display
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
521 @kbd{M-x executable-self-display} adds a magic number to the buffer, which
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
522 will turn it into a self displaying text file, when called as a Un*x command.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
523 The ``interpreter'' used is @code{executable-self-display} with argument
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
524 @samp{+2}.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
525
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
526 @node Timestamps
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
527 @chapter Maintaining Timestamps in Modified Files
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
528 @cindex timestamps
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
529
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
530 @findex time-stamp
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
531 @vindex before-save-hook
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
532 The @code{time-stamp} command can be used to update automatically a
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
533 template in a file with a new time stamp every time you save the file.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
534 Customize the hook @code{before-save-hook} to add the function
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
535 @code{time-stamp} to arrange this. It you use Custom to do this,
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
536 then @code{time-stamp} is conveniently listed as an option in the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
537 customization buffer.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
538
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
539 @vindex time-stamp-active
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
540 @vindex time-stamp-format
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
541 @vindex time-stamp-start
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
542 The time stamp is updated only if the customizable variable
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
543 @code{time-stamp-active} is on, which it is by default; the command
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
544 @code{time-stamp-toggle-active} can be used to toggle it. The format of
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
545 the time stamp is set by the customizable variable
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
546 @code{time-stamp-format}.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
547
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
548 @vindex time-stamp-line-limit
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
549 @vindex time-stamp-end
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
550 @vindex time-stamp-count
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
551 @vindex time-stamp-inserts-lines
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
552 The variables @code{time-stamp-line-limit}, @code{time-stamp-start},
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
553 @code{time-stamp-end}, @code{time-stamp-count}, and
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
554 @code{time-stamp-inserts-lines} control finding the template. Do not
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
555 change these in your init file or you will be incompatible with other
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
556 people's files. If you must change them, do so only in the local
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
557 variables section of the file itself.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
558
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
559 Normally the template must appear in the first 8 lines of a file and
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
560 look like one of the following:
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
561
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
562 @example
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
563 Time-stamp: <>
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
564 Time-stamp: " "
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
565 @end example
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
566
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
567 The time stamp is written between the brackets or quotes:
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
568
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
569 @example
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
570 Time-stamp: <1998-02-18 10:20:51 gildea>
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
571 @end example
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
572
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
573 @node QuickURL
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
574 @chapter QuickURL: Inserting URLs Based on Text at Point
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
575
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
576 @vindex quickurl-url-file
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
577 @findex quickurl
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
578 @cindex URLs
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
579 @kbd{M-x quickurl} can be used to insert a URL into a buffer based on
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
580 the text at point. The URLs are stored in an external file defined by
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
581 the variable @code{quickurl-url-file} as a list of either cons cells of
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
582 the form @code{(@var{key} . @var{URL})} or
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
583 lists of the form @code{(@var{key} @var{URL} @var{comment})}. These
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
584 specify that @kbd{M-x quickurl} should insert @var{URL} if the word
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
585 @var{key} is at point, for example:
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
586
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
587 @example
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
588 (("FSF" "http://www.fsf.org/" "The Free Software Foundation")
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
589 ("emacs" . "http://www.emacs.org/")
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
590 ("hagbard" "http://www.hagbard.demon.co.uk" "Hagbard's World"))
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
591 @end example
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
592
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
593 @findex quickurl-add-url
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
594 @findex quickurl-list
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
595 @kbd{M-x quickurl-add-url} can be used to add a new @var{key}/@var{URL}
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
596 pair. @kbd{M-x quickurl-list} provides interactive editing of the URL
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
597 list.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
598
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
599 @node Tempo
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
600 @chapter Tempo: Flexible Template Insertion
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
601
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
602 @cindex templates
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
603 The Tempo package provides a simple way to define powerful templates, or
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
604 macros, if you wish. It is mainly intended for, but not limited to,
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
605 programmers to be used for creating shortcuts for editing
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
606 certain kinds of documents.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
607
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
608 @findex tempo-backward-mark
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
609 @findex tempo-forward-mark
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
610 A template is defined as a list of items to be inserted in the current
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
611 buffer at point. Some can be simple strings, while others can control
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
612 formatting or define special points of interest in the inserted text.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
613 @kbd{M-x tempo-backward-mark} and @kbd{M-x tempo-forward-mark} can be
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
614 used to jump between such points.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
615
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
616 More flexible templates can be created by including Lisp symbols, which
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
617 will be evaluated as variables, or lists, which will be evaluated
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
618 as Lisp expressions. Automatic completion of specified tags to expanded
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
619 templates can be provided.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
620
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
621 @findex tempo-define-template
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
622 See the documentation for @code{tempo-define-template} for the different
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
623 items that can be used to define a tempo template with a command for
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
624 inserting it.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
625
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
626 See the commentary in @file{tempo.el} for more information on using the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
627 Tempo package.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
628
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
629 @node Hippie Expand
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
630 @chapter `Hippie' Expansion
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
631
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
632 @findex hippie-expand
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
633 @kindex M-/
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
634 @vindex hippie-expand-try-functions-list
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
635 @kbd{M-x hippie-expand} is a single command providing a variety of
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
636 completions and expansions. Called repeatedly, it tries all possible
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
637 completions in succession.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
638
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
639 Which ones to try, and in which order, is determined by the contents of
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
640 the customizable option @code{hippie-expand-try-functions-list}. Much
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
641 customization of the expansion behavior can be made by changing the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
642 order of, removing, or inserting new functions in this list. Given a
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
643 positive numeric argument, @kbd{M-x hippie-expand} jumps directly that
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
644 number of functions forward in this list. Given some other argument (a
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
645 negative argument or just @kbd{C-u}) it undoes the tried completion.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
646
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
647 See the commentary in @file{hippie-exp.el} for more information on the
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
648 possibilities.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
649
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
650 Typically you would bind @code{hippie-expand} to @kbd{M-/} with
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
651 @code{dabbrev-expand}, the standard binding of @kbd{M-/}, providing one
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
652 of the expansion possibilities.
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
653
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
654 @node GNU Free Documentation License
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
655 @appendix GNU Free Documentation License
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
656 @include doclicense.texi
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
657
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
658 @node Concept Index
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
659 @unnumbered Concept Index
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
660 @printindex cp
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
661
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
662 @node Command Index
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
663 @unnumbered Command Index
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
664 @printindex fn
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
665
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
666 @node Variable Index
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
667 @unnumbered Variable Index
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
668 @printindex vr
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
669
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
670 @setchapternewpage odd
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
671 @contents
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
672 @bye
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
673
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
674 @ignore
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
675 arch-tag: 54001b27-5ef8-4a9d-a199-905d650fafba
34396c5da491 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
676 @end ignore