diff options
Diffstat (limited to 'doc/lispref')
| -rw-r--r-- | doc/lispref/ChangeLog | 9 | ||||
| -rw-r--r-- | doc/lispref/buffers.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/display.texi | 3 | ||||
| -rw-r--r-- | doc/lispref/elisp-covers.texi | 257 | ||||
| -rw-r--r-- | doc/lispref/modes.texi | 30 |
5 files changed, 293 insertions, 10 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 91b43eddaab..12539758018 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,12 @@ | |||
| 1 | 2008-01-27 Thien-Thi Nguyen <ttn@gnuvola.org> | ||
| 2 | |||
| 3 | * display.texi (Button Types): | ||
| 4 | For define-button-type, clarify type of NAME. | ||
| 5 | |||
| 6 | 2008-01-19 Martin Rudalics <rudalics@gmx.at> | ||
| 7 | |||
| 8 | * buffers.texi (Buffer Modification): Fix typo. | ||
| 9 | |||
| 1 | 2008-01-06 Dan Nicolaescu <dann@ics.uci.edu> | 10 | 2008-01-06 Dan Nicolaescu <dann@ics.uci.edu> |
| 2 | 11 | ||
| 3 | * os.texi (System Environment): Remove references to OSes that are | 12 | * os.texi (System Environment): Remove references to OSes that are |
diff --git a/doc/lispref/buffers.texi b/doc/lispref/buffers.texi index 0085f2cca77..56e952a44a6 100644 --- a/doc/lispref/buffers.texi +++ b/doc/lispref/buffers.texi | |||
| @@ -584,7 +584,7 @@ The counter can wrap around occasionally. | |||
| 584 | This function returns @var{buffer}'s character-change modification-count. | 584 | This function returns @var{buffer}'s character-change modification-count. |
| 585 | Changes to text properties leave this counter unchanged; however, each | 585 | Changes to text properties leave this counter unchanged; however, each |
| 586 | time text is inserted or removed from the buffer, the counter is reset | 586 | time text is inserted or removed from the buffer, the counter is reset |
| 587 | to the value that would be returned @code{buffer-modified-tick}. | 587 | to the value that would be returned by @code{buffer-modified-tick}. |
| 588 | By comparing the values returned by two @code{buffer-chars-modified-tick} | 588 | By comparing the values returned by two @code{buffer-chars-modified-tick} |
| 589 | calls, you can tell whether a character change occurred in that buffer | 589 | calls, you can tell whether a character change occurred in that buffer |
| 590 | in between the calls. If @var{buffer} is @code{nil} (or omitted), the | 590 | in between the calls. If @var{buffer} is @code{nil} (or omitted), the |
| @@ -783,7 +783,7 @@ are selected for display in a window (@pxref{Displaying Buffers}), and | |||
| 783 | to the end when they are buried (see @code{bury-buffer}, below). | 783 | to the end when they are buried (see @code{bury-buffer}, below). |
| 784 | There are no functions available to the Lisp programmer which directly | 784 | There are no functions available to the Lisp programmer which directly |
| 785 | manipulate the buffer list. | 785 | manipulate the buffer list. |
| 786 | 786 | ||
| 787 | In addition to the fundamental Emacs buffer list, each frame has its | 787 | In addition to the fundamental Emacs buffer list, each frame has its |
| 788 | own version of the buffer list, in which the buffers that have been | 788 | own version of the buffer list, in which the buffers that have been |
| 789 | selected in that frame come first, starting with the buffers most | 789 | selected in that frame come first, starting with the buffers most |
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index b56d24da64e..ee3c828857a 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -4499,7 +4499,8 @@ so that it's easy to define special-purpose types of buttons for | |||
| 4499 | specific tasks. | 4499 | specific tasks. |
| 4500 | 4500 | ||
| 4501 | @defun define-button-type name &rest properties | 4501 | @defun define-button-type name &rest properties |
| 4502 | Define a `button type' called @var{name}. The remaining arguments | 4502 | Define a `button type' called @var{name} (a symbol). |
| 4503 | The remaining arguments | ||
| 4503 | form a sequence of @var{property value} pairs, specifying default | 4504 | form a sequence of @var{property value} pairs, specifying default |
| 4504 | property values for buttons with this type (a button's type may be set | 4505 | property values for buttons with this type (a button's type may be set |
| 4505 | by giving it a @code{type} property when creating the button, using | 4506 | by giving it a @code{type} property when creating the button, using |
diff --git a/doc/lispref/elisp-covers.texi b/doc/lispref/elisp-covers.texi new file mode 100644 index 00000000000..e0162329f51 --- /dev/null +++ b/doc/lispref/elisp-covers.texi | |||
| @@ -0,0 +1,257 @@ | |||
| 1 | \input texinfo @c -*-texinfo-*- | ||
| 2 | @c This is part of the GNU Emacs Lisp Reference Manual. | ||
| 3 | @c Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 | ||
| 4 | @c Free Software Foundation, Inc. | ||
| 5 | @c See the file elisp.texi for copying conditions. | ||
| 6 | @c | ||
| 7 | @comment %**start of header | ||
| 8 | @setfilename covers.info | ||
| 9 | @settitle GNU Emacs Lisp Reference Manual | ||
| 10 | @comment %**end of header | ||
| 11 | |||
| 12 | @titlepage | ||
| 13 | @c ================ Volume 1 ================ | ||
| 14 | @w{ } | ||
| 15 | @sp 2 | ||
| 16 | @center @titlefont{The} | ||
| 17 | @sp 1 | ||
| 18 | @center @titlefont{GNU} | ||
| 19 | @sp 1 | ||
| 20 | @center @titlefont{Emacs Lisp} | ||
| 21 | @sp 1 | ||
| 22 | @center @titlefont{Reference} | ||
| 23 | @sp 1 | ||
| 24 | @center @titlefont{Manual} | ||
| 25 | @sp 2 | ||
| 26 | @center GNU Emacs Version 19 | ||
| 27 | @center for Unix Users | ||
| 28 | @center Edition 2.3, June 1994 | ||
| 29 | @sp 2 | ||
| 30 | @center @titlefont{Volume 1} | ||
| 31 | @sp 2 | ||
| 32 | @center by Bil Lewis, Dan LaLiberte, | ||
| 33 | @center and the GNU Manual Group | ||
| 34 | |||
| 35 | @page | ||
| 36 | @c ================ Volume 2 ================ | ||
| 37 | @w{ } | ||
| 38 | @sp 5 | ||
| 39 | @center @titlefont{The} | ||
| 40 | @sp 1 | ||
| 41 | @center @titlefont{GNU} | ||
| 42 | @sp 1 | ||
| 43 | @center @titlefont{Emacs Lisp} | ||
| 44 | @sp 1 | ||
| 45 | @center @titlefont{Reference} | ||
| 46 | @sp 1 | ||
| 47 | @center @titlefont{Manual} | ||
| 48 | @sp 2 | ||
| 49 | @center GNU Emacs Version 19 | ||
| 50 | @center for Unix Users | ||
| 51 | @center Edition 2.3, June 1994 | ||
| 52 | @sp 2 | ||
| 53 | @center @titlefont{Volume 2} | ||
| 54 | @sp 2 | ||
| 55 | @center by Bil Lewis, | ||
| 56 | @center Dan LaLiberte, and | ||
| 57 | @center the GNU Manual Group | ||
| 58 | |||
| 59 | @page | ||
| 60 | @c ================ Volume 1 with baseline skip 16pt ================ | ||
| 61 | |||
| 62 | @tex | ||
| 63 | \global\baselineskip = 16pt | ||
| 64 | @end tex | ||
| 65 | |||
| 66 | 16 pts baseline skip: | ||
| 67 | |||
| 68 | @w{ } | ||
| 69 | @sp 2 | ||
| 70 | @center @titlefont{The} | ||
| 71 | @sp 1 | ||
| 72 | @center @titlefont{GNU} | ||
| 73 | @sp 1 | ||
| 74 | @center @titlefont{Emacs Lisp} | ||
| 75 | @sp 1 | ||
| 76 | @center @titlefont{Reference} | ||
| 77 | @sp 1 | ||
| 78 | @center @titlefont{Manual} | ||
| 79 | @sp 2 | ||
| 80 | @center GNU Emacs Version 19 | ||
| 81 | @center for Unix Users | ||
| 82 | @center Edition 2.3, June 1994 | ||
| 83 | @sp 2 | ||
| 84 | @center @titlefont{Volume 1} | ||
| 85 | @sp 2 | ||
| 86 | @center by Bil Lewis, Dan LaLiberte, | ||
| 87 | @center and the GNU Manual Group | ||
| 88 | |||
| 89 | @page | ||
| 90 | @c ================ Volume 1 with baseline skip 18pt ================ | ||
| 91 | |||
| 92 | @tex | ||
| 93 | \global\baselineskip = 18pt | ||
| 94 | @end tex | ||
| 95 | |||
| 96 | 18 pts baseline skip, with 15pts between sections | ||
| 97 | |||
| 98 | @w{ } | ||
| 99 | @sp 2 | ||
| 100 | @center @titlefont{The} | ||
| 101 | @sp 1 | ||
| 102 | @center @titlefont{GNU} | ||
| 103 | @sp 1 | ||
| 104 | @center @titlefont{Emacs Lisp} | ||
| 105 | @sp 1 | ||
| 106 | @center @titlefont{Reference} | ||
| 107 | @sp 1 | ||
| 108 | @center @titlefont{Manual} | ||
| 109 | @tex | ||
| 110 | \global\baselineskip = 15pt | ||
| 111 | @end tex | ||
| 112 | |||
| 113 | @sp 2 | ||
| 114 | @center GNU Emacs Version 19 | ||
| 115 | @center for Unix Users | ||
| 116 | @center Edition 2.3, June 1994 | ||
| 117 | @sp 2 | ||
| 118 | @center @titlefont{Volume 1} | ||
| 119 | @sp 2 | ||
| 120 | @center by Bil Lewis, | ||
| 121 | @center Dan LaLiberte, and | ||
| 122 | @center the GNU Manual Group | ||
| 123 | |||
| 124 | @page | ||
| 125 | @c ================ Volume 1 with more baseline skip 24 pts ================ | ||
| 126 | |||
| 127 | @tex | ||
| 128 | \global\baselineskip = 24pt | ||
| 129 | @end tex | ||
| 130 | |||
| 131 | 24 pts baseline skip: | ||
| 132 | |||
| 133 | @w{ } | ||
| 134 | @sp 2 | ||
| 135 | @center @titlefont{The} | ||
| 136 | @sp 1 | ||
| 137 | @center @titlefont{GNU} | ||
| 138 | @sp 1 | ||
| 139 | @center @titlefont{Emacs Lisp} | ||
| 140 | @sp 1 | ||
| 141 | @center @titlefont{Reference} | ||
| 142 | @sp 1 | ||
| 143 | @center @titlefont{Manual} | ||
| 144 | @sp 2 | ||
| 145 | @center GNU Emacs Version 19 | ||
| 146 | @center for Unix Users | ||
| 147 | @center Edition 2.3, June 1994 | ||
| 148 | @sp 2 | ||
| 149 | @center @titlefont{Volume 1} | ||
| 150 | @sp 2 | ||
| 151 | @center by Bil Lewis, Dan LaLiberte, | ||
| 152 | @center and the GNU Manual Group | ||
| 153 | |||
| 154 | @page | ||
| 155 | @c ================ Volume 2 with more baseline skip 18 pts ================ | ||
| 156 | |||
| 157 | @tex | ||
| 158 | \global\baselineskip = 18pt | ||
| 159 | @end tex | ||
| 160 | |||
| 161 | 18 pts baseline skip: | ||
| 162 | |||
| 163 | @w{ } | ||
| 164 | @sp 5 | ||
| 165 | @center @titlefont{The} | ||
| 166 | @sp 1 | ||
| 167 | @center @titlefont{GNU} | ||
| 168 | @sp 1 | ||
| 169 | @center @titlefont{Emacs Lisp} | ||
| 170 | @sp 1 | ||
| 171 | @center @titlefont{Reference} | ||
| 172 | @sp 1 | ||
| 173 | @center @titlefont{Manual} | ||
| 174 | @sp 2 | ||
| 175 | @center GNU Emacs Version 19 | ||
| 176 | @center for Unix Users | ||
| 177 | @center Edition 2.3, June 1994 | ||
| 178 | @sp 2 | ||
| 179 | @center @titlefont{Volume 2} | ||
| 180 | @sp 2 | ||
| 181 | @center by Bil Lewis, Dan LaLiberte, | ||
| 182 | @center and the GNU Manual Group | ||
| 183 | |||
| 184 | @page | ||
| 185 | @c ================ Volume 2 with more baseline skip 24 pts ================ | ||
| 186 | |||
| 187 | @tex | ||
| 188 | \global\baselineskip = 24pt | ||
| 189 | @end tex | ||
| 190 | |||
| 191 | 24 pts baseline skip: | ||
| 192 | |||
| 193 | @w{ } | ||
| 194 | @sp 5 | ||
| 195 | @center @titlefont{The} | ||
| 196 | @sp 1 | ||
| 197 | @center @titlefont{GNU} | ||
| 198 | @sp 1 | ||
| 199 | @center @titlefont{Emacs Lisp} | ||
| 200 | @sp 1 | ||
| 201 | @center @titlefont{Reference} | ||
| 202 | @sp 1 | ||
| 203 | @center @titlefont{Manual} | ||
| 204 | @sp 2 | ||
| 205 | @center GNU Emacs Version 19 | ||
| 206 | @center for Unix Users | ||
| 207 | @center Edition 2.3, June 1994 | ||
| 208 | @sp 2 | ||
| 209 | @center @titlefont{Volume 2} | ||
| 210 | @sp 2 | ||
| 211 | @center by Bil Lewis, Dan LaLiberte, | ||
| 212 | @center and the GNU Manual Group | ||
| 213 | |||
| 214 | |||
| 215 | @page | ||
| 216 | @c ================ Spine 1 ================ | ||
| 217 | |||
| 218 | @w{@titlefont{The GNU Emacs Lisp Reference Manual --- Vol. 1}} | ||
| 219 | @sp 4 | ||
| 220 | @center GNU Emacs Version 19 | ||
| 221 | @center for Unix Users | ||
| 222 | @center Edition 2.3, June 1994 | ||
| 223 | @sp 4 | ||
| 224 | @center by Bil Lewis, Dan LaLiberte, | ||
| 225 | @center and the GNU Manual Group | ||
| 226 | |||
| 227 | @sp 4 | ||
| 228 | @author The GNU Emacs Lisp Reference Manual --- Vol. 1 | ||
| 229 | @sp 3 | ||
| 230 | @author FSF | ||
| 231 | |||
| 232 | @author | ||
| 233 | |||
| 234 | @page | ||
| 235 | @c ================ Spine 2 ================ | ||
| 236 | |||
| 237 | @w{@titlefont{The GNU Emacs Lisp Reference Manual --- Vol. 2}} | ||
| 238 | @sp 4 | ||
| 239 | @center GNU Emacs Version 19 | ||
| 240 | @center for Unix Users | ||
| 241 | @center Edition 2.3, June 1994 | ||
| 242 | @sp 4 | ||
| 243 | @center by Bil Lewis, Dan LaLiberte, | ||
| 244 | @center and the GNU Manual Group | ||
| 245 | |||
| 246 | |||
| 247 | @sp 4 | ||
| 248 | @author The GNU Emacs Lisp Reference Manual --- Vol. 2 | ||
| 249 | @sp 3 | ||
| 250 | @author FSF | ||
| 251 | |||
| 252 | @end titlepage | ||
| 253 | @bye | ||
| 254 | |||
| 255 | @ignore | ||
| 256 | arch-tag: 02d65d63-3b64-49bc-a5c0-bfd5eabb6c98 | ||
| 257 | @end ignore | ||
diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index 38e93b2033e..3004ca3a934 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi | |||
| @@ -77,15 +77,16 @@ convention. | |||
| 77 | @samp{-hooks}. If the variable's name ends in @samp{-function}, then | 77 | @samp{-hooks}. If the variable's name ends in @samp{-function}, then |
| 78 | its value is just a single function, not a list of functions. | 78 | its value is just a single function, not a list of functions. |
| 79 | 79 | ||
| 80 | Here's an example that uses a mode hook to turn on Auto Fill mode when | 80 | @menu |
| 81 | in Lisp Interaction mode: | 81 | * Running Hooks:: How to run a hook. |
| 82 | * Setting Hooks:: How to put functions on a hook, or remove them. | ||
| 83 | @end menu | ||
| 82 | 84 | ||
| 83 | @example | 85 | @node Running Hooks |
| 84 | (add-hook 'lisp-interaction-mode-hook 'turn-on-auto-fill) | 86 | @subsection Running Hooks |
| 85 | @end example | ||
| 86 | 87 | ||
| 87 | At the appropriate time, Emacs uses the @code{run-hooks} function to | 88 | At the appropriate times, Emacs uses the @code{run-hooks} function |
| 88 | run particular hooks. | 89 | and the other functions below to run particular hooks. |
| 89 | 90 | ||
| 90 | @defun run-hooks &rest hookvars | 91 | @defun run-hooks &rest hookvars |
| 91 | This function takes one or more normal hook variable names as | 92 | This function takes one or more normal hook variable names as |
| @@ -125,6 +126,16 @@ the last hook function that was called. If all hook functions return | |||
| 125 | @code{nil}, it returns @code{nil} as well. | 126 | @code{nil}, it returns @code{nil} as well. |
| 126 | @end defun | 127 | @end defun |
| 127 | 128 | ||
| 129 | @node Setting Hooks | ||
| 130 | @subsection Setting Hooks | ||
| 131 | |||
| 132 | Here's an example that uses a mode hook to turn on Auto Fill mode when | ||
| 133 | in Lisp Interaction mode: | ||
| 134 | |||
| 135 | @example | ||
| 136 | (add-hook 'lisp-interaction-mode-hook 'turn-on-auto-fill) | ||
| 137 | @end example | ||
| 138 | |||
| 128 | @defun add-hook hook function &optional append local | 139 | @defun add-hook hook function &optional append local |
| 129 | This function is the handy way to add function @var{function} to hook | 140 | This function is the handy way to add function @var{function} to hook |
| 130 | variable @var{hook}. You can use it for abnormal hooks as well as for | 141 | variable @var{hook}. You can use it for abnormal hooks as well as for |
| @@ -141,6 +152,11 @@ adds @code{my-text-hook-function} to the hook called @code{text-mode-hook}. | |||
| 141 | If @var{function} is already present in @var{hook} (comparing using | 152 | If @var{function} is already present in @var{hook} (comparing using |
| 142 | @code{equal}), then @code{add-hook} does not add it a second time. | 153 | @code{equal}), then @code{add-hook} does not add it a second time. |
| 143 | 154 | ||
| 155 | If @var{function} has a non-@code{nil} property | ||
| 156 | @code{permanent-local-hook}, then @code{kill-all-local-variables} (or | ||
| 157 | changing major modes) won't delete it from the hook variable's local | ||
| 158 | value. | ||
| 159 | |||
| 144 | It is best to design your hook functions so that the order in which they | 160 | It is best to design your hook functions so that the order in which they |
| 145 | are executed does not matter. Any dependence on the order is ``asking | 161 | are executed does not matter. Any dependence on the order is ``asking |
| 146 | for trouble.'' However, the order is predictable: normally, | 162 | for trouble.'' However, the order is predictable: normally, |