diff options
| author | Kenichi Handa | 2010-08-25 14:15:20 +0900 |
|---|---|---|
| committer | Kenichi Handa | 2010-08-25 14:15:20 +0900 |
| commit | 4e603db3429957e6b26953c177f00a9c9d1c8766 (patch) | |
| tree | 8206240e3006468bff9dfda5fb3696f80fbcb9f0 /doc/lispref | |
| parent | b60f961f6cdc1095e778ad624657bb57788512af (diff) | |
| parent | f6aa6ec68ed936800ef2c3aefa42102e60b654cb (diff) | |
| download | emacs-4e603db3429957e6b26953c177f00a9c9d1c8766.tar.gz emacs-4e603db3429957e6b26953c177f00a9c9d1c8766.zip | |
merge trunk
Diffstat (limited to 'doc/lispref')
| -rw-r--r-- | doc/lispref/ChangeLog | 26 | ||||
| -rw-r--r-- | doc/lispref/commands.texi | 10 | ||||
| -rw-r--r-- | doc/lispref/compile.texi | 6 | ||||
| -rw-r--r-- | doc/lispref/display.texi | 46 | ||||
| -rw-r--r-- | doc/lispref/loading.texi | 7 | ||||
| -rw-r--r-- | doc/lispref/modes.texi | 12 | ||||
| -rw-r--r-- | doc/lispref/nonascii.texi | 3 | ||||
| -rw-r--r-- | doc/lispref/objects.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/processes.texi | 28 |
9 files changed, 101 insertions, 41 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index fe64ca9d835..53b8ac25522 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,29 @@ | |||
| 1 | 2010-08-24 Markus Triska <triska@gmx.at> | ||
| 2 | |||
| 3 | * processes.texi (Filter Functions): Use `buffer-live-p' instead | ||
| 4 | of `buffer-name' in the main text as well as in the example | ||
| 5 | (Bug#3098). | ||
| 6 | |||
| 7 | 2010-08-22 Chong Yidong <cyd@stupidchicken.com> | ||
| 8 | |||
| 9 | * nonascii.texi (Text Representations): | ||
| 10 | * loading.texi (Loading Non-ASCII): | ||
| 11 | * compile.texi (Byte Compilation): Don't mention obsolete | ||
| 12 | --unibyte command-line argument. | ||
| 13 | |||
| 14 | 2010-08-22 Chong Yidong <cyd@stupidchicken.com> | ||
| 15 | |||
| 16 | * modes.texi (Defining Minor Modes): Doc fix (Bug#6880). | ||
| 17 | |||
| 18 | 2010-08-22 Chong Yidong <cyd@stupidchicken.com> | ||
| 19 | |||
| 20 | * objects.texi (Bool-Vector Type): Minor definition tweak (Bug#6878). | ||
| 21 | |||
| 22 | 2010-08-20 Eli Zaretskii <eliz@gnu.org> | ||
| 23 | |||
| 24 | * commands.texi (Misc Events): Add cross-references to where | ||
| 25 | POSITION of a mouse event is described in detail. | ||
| 26 | |||
| 1 | 2010-08-08 Christoph <cschol2112@googlemail.com> | 27 | 2010-08-08 Christoph <cschol2112@googlemail.com> |
| 2 | 28 | ||
| 3 | * control.texi (Handling Errors) <error-message-string>: Fix arg name. | 29 | * control.texi (Handling Errors) <error-message-string>: Fix arg name. |
diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi index d22cfd955cb..17cfcc0def8 100644 --- a/doc/lispref/commands.texi +++ b/doc/lispref/commands.texi | |||
| @@ -1616,7 +1616,8 @@ These kinds of event are generated by moving a mouse wheel. Their | |||
| 1616 | usual meaning is a kind of scroll or zoom. | 1616 | usual meaning is a kind of scroll or zoom. |
| 1617 | 1617 | ||
| 1618 | The element @var{position} is a list describing the position of the | 1618 | The element @var{position} is a list describing the position of the |
| 1619 | event, in the same format as used in a mouse-click event. | 1619 | event, in the same format as used in a mouse-click event (@pxref{Click |
| 1620 | Events}). | ||
| 1620 | 1621 | ||
| 1621 | @vindex mouse-wheel-up-event | 1622 | @vindex mouse-wheel-up-event |
| 1622 | @vindex mouse-wheel-down-event | 1623 | @vindex mouse-wheel-down-event |
| @@ -1633,9 +1634,10 @@ selected in an application outside of Emacs, and then dragged and | |||
| 1633 | dropped onto an Emacs frame. | 1634 | dropped onto an Emacs frame. |
| 1634 | 1635 | ||
| 1635 | The element @var{position} is a list describing the position of the | 1636 | The element @var{position} is a list describing the position of the |
| 1636 | event, in the same format as used in a mouse-click event, and | 1637 | event, in the same format as used in a mouse-click event (@pxref{Click |
| 1637 | @var{files} is the list of file names that were dragged and dropped. | 1638 | Events}), and @var{files} is the list of file names that were dragged |
| 1638 | The usual way to handle this event is by visiting these files. | 1639 | and dropped. The usual way to handle this event is by visiting these |
| 1640 | files. | ||
| 1639 | 1641 | ||
| 1640 | This kind of event is generated, at present, only on some kinds of | 1642 | This kind of event is generated, at present, only on some kinds of |
| 1641 | systems. | 1643 | systems. |
diff --git a/doc/lispref/compile.texi b/doc/lispref/compile.texi index 1c28664e7c3..69b57f19ea7 100644 --- a/doc/lispref/compile.texi +++ b/doc/lispref/compile.texi | |||
| @@ -22,12 +22,6 @@ hardware (as true compiled code is), byte-code is completely | |||
| 22 | transportable from machine to machine without recompilation. It is not, | 22 | transportable from machine to machine without recompilation. It is not, |
| 23 | however, as fast as true compiled code. | 23 | however, as fast as true compiled code. |
| 24 | 24 | ||
| 25 | Compiling a Lisp file with the Emacs byte compiler always reads the | ||
| 26 | file as multibyte text, even if Emacs was started with @samp{--unibyte}, | ||
| 27 | unless the file specifies otherwise. This is so that compilation gives | ||
| 28 | results compatible with running the same file without compilation. | ||
| 29 | @xref{Loading Non-ASCII}. | ||
| 30 | |||
| 31 | In general, any version of Emacs can run byte-compiled code produced | 25 | In general, any version of Emacs can run byte-compiled code produced |
| 32 | by recent earlier versions of Emacs, but the reverse is not true. | 26 | by recent earlier versions of Emacs, but the reverse is not true. |
| 33 | 27 | ||
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 9f07fb42ef4..716efbd9059 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -4039,6 +4039,7 @@ displayed (@pxref{Display Feature Testing}). | |||
| 4039 | * GIF Images:: Special features for GIF format. | 4039 | * GIF Images:: Special features for GIF format. |
| 4040 | * TIFF Images:: Special features for TIFF format. | 4040 | * TIFF Images:: Special features for TIFF format. |
| 4041 | * PostScript Images:: Special features for PostScript format. | 4041 | * PostScript Images:: Special features for PostScript format. |
| 4042 | * ImageMagick Images:: Special features available through ImageMagick. | ||
| 4042 | * Other Image Types:: Various other formats are supported. | 4043 | * Other Image Types:: Various other formats are supported. |
| 4043 | * Defining Images:: Convenient ways to define an image for later use. | 4044 | * Defining Images:: Convenient ways to define an image for later use. |
| 4044 | * Showing Images:: Convenient ways to display an image once it is defined. | 4045 | * Showing Images:: Convenient ways to display an image once it is defined. |
| @@ -4463,6 +4464,51 @@ specifying the bounding box of the PostScript image, analogous to the | |||
| 4463 | @end example | 4464 | @end example |
| 4464 | @end table | 4465 | @end table |
| 4465 | 4466 | ||
| 4467 | @node ImageMagick Images | ||
| 4468 | @subsection ImageMagick Images | ||
| 4469 | The Imagemagick library can be used to load many image formats in Emacs. | ||
| 4470 | |||
| 4471 | The function (imagemagick-types) returns a list of image file | ||
| 4472 | extensions that your installation of imagemagick supports. | ||
| 4473 | |||
| 4474 | The function (imagemagick-register-types) will enable the imagemagick | ||
| 4475 | support for the extensions in imagemagick-types minus the types listed | ||
| 4476 | in imagemagick-types-inhibit. | ||
| 4477 | |||
| 4478 | imagemagick-types-inhibit has the value '(C HTML HTM TXT PDF) by | ||
| 4479 | default. There can be overlap between image loaders in your Emacs | ||
| 4480 | installation. If you never want to use the ImageMagick loader to use | ||
| 4481 | Jpeg files, for instance, add 'JPG to imagemagick-types-inhibit. Which | ||
| 4482 | loader that will be used in practice depends on the priority of the | ||
| 4483 | loaders. | ||
| 4484 | |||
| 4485 | imagemagick-render-type is a new variable which can be set to choose | ||
| 4486 | between screen render methods for the ImageMagick loader. | ||
| 4487 | |||
| 4488 | - 0 is a conservative metod which works with older ImageMagick | ||
| 4489 | versions. It is a bit slow, but robust. | ||
| 4490 | |||
| 4491 | - 1 utilizes a newer ImageMagick method | ||
| 4492 | |||
| 4493 | |||
| 4494 | Images loaded with imagemagick will support a couple of new display | ||
| 4495 | specification behaviours: | ||
| 4496 | |||
| 4497 | - if the :width and :height keywords are specified, these values are | ||
| 4498 | used for scaling the image. If only one of :width or :height is | ||
| 4499 | specified, the other one will be calculated so as to preserve the | ||
| 4500 | aspect ratio.If both :width and :height are specified, aspect ratio | ||
| 4501 | will not be preserved. | ||
| 4502 | |||
| 4503 | - :rotation specifies a rotation angle in degrees. | ||
| 4504 | |||
| 4505 | - :index specifies which image inside an image bundle file format, such | ||
| 4506 | as TIFF or DJVM, to view. | ||
| 4507 | |||
| 4508 | The image-metadata function can be used to retrieve the total number | ||
| 4509 | of images in an image bundle. This is simmilar to how GIF files work. | ||
| 4510 | |||
| 4511 | |||
| 4466 | @node Other Image Types | 4512 | @node Other Image Types |
| 4467 | @subsection Other Image Types | 4513 | @subsection Other Image Types |
| 4468 | @cindex PBM | 4514 | @cindex PBM |
diff --git a/doc/lispref/loading.texi b/doc/lispref/loading.texi index bbdd67fc3a5..dee2a0252eb 100644 --- a/doc/lispref/loading.texi +++ b/doc/lispref/loading.texi | |||
| @@ -367,13 +367,6 @@ example) is read without decoding, the text of the program will be | |||
| 367 | unibyte text, and its string constants will be unibyte strings. | 367 | unibyte text, and its string constants will be unibyte strings. |
| 368 | @xref{Coding Systems}. | 368 | @xref{Coding Systems}. |
| 369 | 369 | ||
| 370 | To make the results more predictable, Emacs always performs decoding | ||
| 371 | into the multibyte representation when loading Lisp files, even if it | ||
| 372 | was started with the @samp{--unibyte} option. This means that string | ||
| 373 | constants with non-@acronym{ASCII} characters translate into multibyte | ||
| 374 | strings. The only exception is when a particular file specifies no | ||
| 375 | decoding. | ||
| 376 | |||
| 377 | The reason Emacs is designed this way is so that Lisp programs give | 370 | The reason Emacs is designed this way is so that Lisp programs give |
| 378 | predictable results, regardless of how Emacs was started. In addition, | 371 | predictable results, regardless of how Emacs was started. In addition, |
| 379 | this enables programs that depend on using multibyte text to work even | 372 | this enables programs that depend on using multibyte text to work even |
diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index 3953da59b93..12f16b67663 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi | |||
| @@ -1411,14 +1411,20 @@ The string @var{lighter} says what to display in the mode line | |||
| 1411 | when the mode is enabled; if it is @code{nil}, the mode is not displayed | 1411 | when the mode is enabled; if it is @code{nil}, the mode is not displayed |
| 1412 | in the mode line. | 1412 | in the mode line. |
| 1413 | 1413 | ||
| 1414 | The optional argument @var{keymap} specifies the keymap for the minor mode. | 1414 | The optional argument @var{keymap} specifies the keymap for the minor |
| 1415 | It can be a variable name, whose value is the keymap, or it can be an alist | 1415 | mode. If non-@code{nil}, it should be a variable name (whose value is |
| 1416 | specifying bindings in this form: | 1416 | a keymap), a keymap, or an alist of the form |
| 1417 | 1417 | ||
| 1418 | @example | 1418 | @example |
| 1419 | (@var{key-sequence} . @var{definition}) | 1419 | (@var{key-sequence} . @var{definition}) |
| 1420 | @end example | 1420 | @end example |
| 1421 | 1421 | ||
| 1422 | @noindent | ||
| 1423 | where each @var{key-sequence} and @var{definition} are arguments | ||
| 1424 | suitable for passing to @code{define-key} (@pxref{Changing Key | ||
| 1425 | Bindings}). If @var{keymap} is a keymap or an alist, this also | ||
| 1426 | defines the variable @code{@var{mode}-map}. | ||
| 1427 | |||
| 1422 | The above three arguments @var{init-value}, @var{lighter}, and | 1428 | The above three arguments @var{init-value}, @var{lighter}, and |
| 1423 | @var{keymap} can be (partially) omitted when @var{keyword-args} are | 1429 | @var{keymap} can be (partially) omitted when @var{keyword-args} are |
| 1424 | used. The @var{keyword-args} consist of keywords followed by | 1430 | used. The @var{keyword-args} consist of keywords followed by |
diff --git a/doc/lispref/nonascii.texi b/doc/lispref/nonascii.texi index 00a1dffed6a..40c78d97da7 100644 --- a/doc/lispref/nonascii.texi +++ b/doc/lispref/nonascii.texi | |||
| @@ -102,9 +102,6 @@ it contains unibyte encoded text or binary non-text data. | |||
| 102 | 102 | ||
| 103 | You cannot set this variable directly; instead, use the function | 103 | You cannot set this variable directly; instead, use the function |
| 104 | @code{set-buffer-multibyte} to change a buffer's representation. | 104 | @code{set-buffer-multibyte} to change a buffer's representation. |
| 105 | |||
| 106 | The @samp{--unibyte} command line option does its job by setting the | ||
| 107 | default value to @code{nil} early in startup. | ||
| 108 | @end defvar | 105 | @end defvar |
| 109 | 106 | ||
| 110 | @defun position-bytes position | 107 | @defun position-bytes position |
diff --git a/doc/lispref/objects.texi b/doc/lispref/objects.texi index 5c3ac13cdaf..c8ccb15a2d3 100644 --- a/doc/lispref/objects.texi +++ b/doc/lispref/objects.texi | |||
| @@ -1189,8 +1189,8 @@ Syntax tables (@pxref{Syntax Tables}). | |||
| 1189 | @node Bool-Vector Type | 1189 | @node Bool-Vector Type |
| 1190 | @subsection Bool-Vector Type | 1190 | @subsection Bool-Vector Type |
| 1191 | 1191 | ||
| 1192 | A @dfn{bool-vector} is a one-dimensional array of elements that | 1192 | A @dfn{bool-vector} is a one-dimensional array whose elements must |
| 1193 | must be @code{t} or @code{nil}. | 1193 | be @code{t} or @code{nil}. |
| 1194 | 1194 | ||
| 1195 | The printed representation of a bool-vector is like a string, except | 1195 | The printed representation of a bool-vector is like a string, except |
| 1196 | that it begins with @samp{#&} followed by the length. The string | 1196 | that it begins with @samp{#&} followed by the length. The string |
diff --git a/doc/lispref/processes.texi b/doc/lispref/processes.texi index 747d865b0e1..265c76471f0 100644 --- a/doc/lispref/processes.texi +++ b/doc/lispref/processes.texi | |||
| @@ -1273,22 +1273,24 @@ process's buffer, mimicking the actions of Emacs when there is no | |||
| 1273 | filter. Such filter functions need to use @code{set-buffer} in order to | 1273 | filter. Such filter functions need to use @code{set-buffer} in order to |
| 1274 | be sure to insert in that buffer. To avoid setting the current buffer | 1274 | be sure to insert in that buffer. To avoid setting the current buffer |
| 1275 | semipermanently, these filter functions must save and restore the | 1275 | semipermanently, these filter functions must save and restore the |
| 1276 | current buffer. They should also update the process marker, and in some | 1276 | current buffer. They should also check whether the buffer is still |
| 1277 | cases update the value of point. Here is how to do these things: | 1277 | alive, update the process marker, and in some cases update the value |
| 1278 | of point. Here is how to do these things: | ||
| 1278 | 1279 | ||
| 1279 | @smallexample | 1280 | @smallexample |
| 1280 | @group | 1281 | @group |
| 1281 | (defun ordinary-insertion-filter (proc string) | 1282 | (defun ordinary-insertion-filter (proc string) |
| 1282 | (with-current-buffer (process-buffer proc) | 1283 | (when (buffer-live-p (process-buffer proc)) |
| 1283 | (let ((moving (= (point) (process-mark proc)))) | 1284 | (with-current-buffer (process-buffer proc) |
| 1285 | (let ((moving (= (point) (process-mark proc)))) | ||
| 1284 | @end group | 1286 | @end group |
| 1285 | @group | 1287 | @group |
| 1286 | (save-excursion | 1288 | (save-excursion |
| 1287 | ;; @r{Insert the text, advancing the process marker.} | 1289 | ;; <at> r{Insert the text, advancing the process marker.} |
| 1288 | (goto-char (process-mark proc)) | 1290 | (goto-char (process-mark proc)) |
| 1289 | (insert string) | 1291 | (insert string) |
| 1290 | (set-marker (process-mark proc) (point))) | 1292 | (set-marker (process-mark proc) (point))) |
| 1291 | (if moving (goto-char (process-mark proc)))))) | 1293 | (if moving (goto-char (process-mark proc))))))) |
| 1292 | @end group | 1294 | @end group |
| 1293 | @end smallexample | 1295 | @end smallexample |
| 1294 | 1296 | ||
| @@ -1315,12 +1317,6 @@ expression searching or matching had to explicitly save and restore the | |||
| 1315 | match data. Now Emacs does this automatically for filter functions; | 1317 | match data. Now Emacs does this automatically for filter functions; |
| 1316 | they never need to do it explicitly. @xref{Match Data}. | 1318 | they never need to do it explicitly. @xref{Match Data}. |
| 1317 | 1319 | ||
| 1318 | A filter function that writes the output into the buffer of the | ||
| 1319 | process should check whether the buffer is still alive. If it tries to | ||
| 1320 | insert into a dead buffer, it will get an error. The expression | ||
| 1321 | @code{(buffer-name (process-buffer @var{process}))} returns @code{nil} | ||
| 1322 | if the buffer is dead. | ||
| 1323 | |||
| 1324 | The output to the function may come in chunks of any size. A program | 1320 | The output to the function may come in chunks of any size. A program |
| 1325 | that produces the same output twice in a row may send it as one batch of | 1321 | that produces the same output twice in a row may send it as one batch of |
| 1326 | 200 characters one time, and five batches of 40 characters the next. If | 1322 | 200 characters one time, and five batches of 40 characters the next. If |