summaryrefslogtreecommitdiff
path: root/doc/lispref/display.texi
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2023-04-08 14:33:06 +0300
committerEli Zaretskii <eliz@gnu.org>2023-04-08 14:33:06 +0300
commit96714c106b7a3f86ca4c78052178a62d351f1751 (patch)
tree66d254ab2dd740eaefe65304bf13e0d3af8965d7 /doc/lispref/display.texi
parent6a2863ca0167a1b4a431dfae3640c97a846d4826 (diff)
downloademacs-96714c106b7a3f86ca4c78052178a62d351f1751.tar.gz
Improve documentation of image-related commands
* lisp/image.el (image-map): Make it inherit from 'image-slice-map' instead of repeating the bindings. * doc/emacs/files.texi (Image Mode): Document the key bindings set by 'insert-image'. Add indexing. * doc/lispref/display.texi (Showing Images): Make the description of user commands more concise. Add index entries and cross-reference to the Emacs manual. * etc/NEWS: Rearrange entries relevant to image commands.
Diffstat (limited to 'doc/lispref/display.texi')
-rw-r--r--doc/lispref/display.texi30
1 files changed, 18 insertions, 12 deletions
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index 85fac4b30a6..8184021d998 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -6876,7 +6876,7 @@ This function puts image @var{image} in front of @var{pos} in the
current buffer. The argument @var{pos} should be an integer or a
marker. It specifies the buffer position where the image should appear.
The argument @var{string} specifies the text that should hold the image
-as an alternative to the default.
+as an alternative to the default @samp{x}.
The argument @var{image} must be an image descriptor, perhaps returned
by @code{create-image} or stored by @code{defimage}.
@@ -6889,7 +6889,7 @@ buffer's text.
Internally, this function creates an overlay, and gives it a
@code{before-string} property containing text that has a @code{display}
-property whose value is the image. (Whew!)
+property whose value is the image. (Whew! that was a mouthful@dots{})
@end defun
@defun remove-images start end &optional buffer
@@ -6936,41 +6936,47 @@ This function returns @code{t} if point is on an image, and @code{nil}
otherwise.
@end defun
+@cindex operations on images
Images inserted with the insertion functions above also get a local
keymap installed in the text properties (or overlays) that span the
displayed image. This keymap defines the following commands:
@table @kbd
+@findex image-increase-size
@item i +
-Increase the image size (@code{image-increase-size}). A prefix value
-of @samp{4} means to increase the size by 40%. The default is 20%.
+Increase the image size (@code{image-increase-size})
+@findex image-decrease-size
@item i -
-Decrease the image size (@code{image-increase-size}). A prefix value
-of @samp{4} means to decrease the size by 40%. The default is 20%.
+Decrease the image size (@code{image-decrease-size}).
+@findex image-rotate
@item i r
-Rotate the image by 90 degrees clockwise (@code{image-rotate}).
-A prefix means to rotate by 90 degrees counter-clockwise instead.
+Rotate the image (@code{image-rotate}).
+@findex image-flip-horizontally
@item i h
Flip the image horizontally (@code{image-flip-horizontally}).
+@findex image-flip-vertically
@item i v
Flip the image vertically (@code{image-flip-vertically}).
+@findex image-save
@item i o
Save the image to a file (@code{image-save}).
+@findex image-crop
@item i c
-Crop the image interactively (@code{image-crop}).
+Interactively crop the image (@code{image-crop}).
+@findex image-cut
@item i x
-Cut a rectangle from the image interactively (@code{image-cut}).
+Interactively cut a rectangle from the image (@code{image-cut}).
@end table
-The size and rotation commands are ``repeating'', which means that you
-can continue adjusting the image without using the @kbd{i} prefix.
+@xref{Image Mode,,, emacs, The GNU Emacs Manual}, for more details
+about these image-specific key bindings.
@node Multi-Frame Images
@subsection Multi-Frame Images