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