aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/ChangeLog8
-rw-r--r--doc/lispref/display.texi109
-rw-r--r--doc/lispref/elisp.texi4
-rw-r--r--doc/misc/ChangeLog5
-rw-r--r--doc/misc/cl.texi16
-rw-r--r--doc/misc/tramp.texi33
6 files changed, 102 insertions, 73 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index fe61fb4dce1..74f2eb9312b 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,11 @@
12013-02-20 Glenn Morris <rgm@gnu.org>
2
3 * display.texi (GIF Images, TIFF Images): Delete these nodes.
4 (ImageMagick Images): For :index, use an xref rather than duplicating.
5 (Other Image Types): Add GIF, adjust formatting.
6 (Multi-Frame Images): Rename from Animated Images. Expand section.
7 * elisp.texi (Top): Update menu for these changes.
8
12013-02-19 Glenn Morris <rgm@gnu.org> 92013-02-19 Glenn Morris <rgm@gnu.org>
2 10
3 * text.texi (Change Hooks): Fix typo. 11 * text.texi (Change Hooks): Fix typo.
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index cc6e980dadc..1e596c14233 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -4199,14 +4199,12 @@ displayed (@pxref{Display Feature Testing}).
4199* Image Descriptors:: How to specify an image for use in @code{:display}. 4199* Image Descriptors:: How to specify an image for use in @code{:display}.
4200* XBM Images:: Special features for XBM format. 4200* XBM Images:: Special features for XBM format.
4201* XPM Images:: Special features for XPM format. 4201* XPM Images:: Special features for XPM format.
4202* GIF Images:: Special features for GIF format.
4203* TIFF Images:: Special features for TIFF format.
4204* PostScript Images:: Special features for PostScript format. 4202* PostScript Images:: Special features for PostScript format.
4205* ImageMagick Images:: Special features available through ImageMagick. 4203* ImageMagick Images:: Special features available through ImageMagick.
4206* Other Image Types:: Various other formats are supported. 4204* Other Image Types:: Various other formats are supported.
4207* Defining Images:: Convenient ways to define an image for later use. 4205* Defining Images:: Convenient ways to define an image for later use.
4208* Showing Images:: Convenient ways to display an image once it is defined. 4206* Showing Images:: Convenient ways to display an image once it is defined.
4209* Animated Images:: Some image formats can be animated. 4207* Multi-Frame Images:: Some images contain more than one frame.
4210* Image Cache:: Internal mechanisms of image display. 4208* Image Cache:: Internal mechanisms of image display.
4211@end menu 4209@end menu
4212 4210
@@ -4541,35 +4539,6 @@ the name of a color as it appears in the image file, and @var{color}
4541specifies the actual color to use for displaying that name. 4539specifies the actual color to use for displaying that name.
4542@end table 4540@end table
4543 4541
4544@node GIF Images
4545@subsection GIF Images
4546@cindex GIF
4547
4548 For GIF images, specify image type @code{gif}.
4549
4550@table @code
4551@item :index @var{index}
4552You can use @code{:index} to specify image number @var{index} from a
4553GIF file that contains more than one image. If the GIF file doesn't
4554contain an image with the specified index, the image displays as a
4555hollow box. GIF files with more than one image can be animated,
4556@pxref{Animated Images}.
4557@end table
4558
4559@node TIFF Images
4560@subsection TIFF Images
4561@cindex TIFF
4562
4563 For TIFF images, specify image type @code{tiff}.
4564
4565@table @code
4566@item :index @var{index}
4567You can use @code{:index} to specify image number @var{index} from a
4568TIFF file that contains more than one image. If the TIFF file doesn't
4569contain an image with the specified index, the image displays as a
4570hollow box.
4571@end table
4572
4573@node PostScript Images 4542@node PostScript Images
4574@subsection PostScript Images 4543@subsection PostScript Images
4575@cindex postscript images 4544@cindex postscript images
@@ -4653,10 +4622,7 @@ Specifies a rotation angle in degrees.
4653 4622
4654@item :index 4623@item :index
4655@c Doesn't work: http://debbugs.gnu.org/7978 4624@c Doesn't work: http://debbugs.gnu.org/7978
4656This has the same meaning as it does for GIF images (@pxref{GIF Images}), 4625@xref{Multi-Frame Images}.
4657i.e., it specifies which image to view inside an image bundle file format
4658such as DJVM@. You can use the @code{image-metadata} function to
4659retrieve the total number of images in an image bundle.
4660@end table 4626@end table
4661 4627
4662@node Other Image Types 4628@node Other Image Types
@@ -4681,13 +4647,27 @@ used for each pixel in the PBM that is 0. The default is the frame's
4681background color. 4647background color.
4682@end table 4648@end table
4683 4649
4684 For JPEG images, specify image type @code{jpeg}. 4650@noindent
4651The remaining image types that Emacs can support are:
4685 4652
4686 For TIFF images, specify image type @code{tiff}. 4653@table @asis
4654@item GIF
4655Image type @code{gif}.
4656Supports the @code{:index} property. @xref{Multi-Frame Images}.
4657
4658@item JPEG
4659Image type @code{jpeg}.
4687 4660
4688 For PNG images, specify image type @code{png}. 4661@item PNG
4662Image type @code{png}.
4689 4663
4690 For SVG images, specify image type @code{svg}. 4664@item SVG
4665Image type @code{svg}.
4666
4667@item TIFF
4668Image type @code{tiff}.
4669Supports the @code{:index} property. @xref{Multi-Frame Images}.
4670@end table
4691 4671
4692@node Defining Images 4672@node Defining Images
4693@subsection Defining Images 4673@subsection Defining Images
@@ -4923,20 +4903,45 @@ cache, it can always be displayed, even if the value of
4923@var{max-image-size} is subsequently changed (@pxref{Image Cache}). 4903@var{max-image-size} is subsequently changed (@pxref{Image Cache}).
4924@end defvar 4904@end defvar
4925 4905
4926@node Animated Images 4906@node Multi-Frame Images
4927@subsection Animated Images 4907@subsection Multi-Frame Images
4928 4908
4929@cindex animation 4909@cindex animation
4930@cindex image animation 4910@cindex image animation
4931Some image files can contain more than one image. This can be used to 4911@cindex image frames
4932create animation. Currently, Emacs only supports animated GIF files. 4912Some image files can contain more than one image. We say that there
4933The following functions related to animated images are available. 4913are multiple ``frames'' in the image. At present, Emacs supports
4914multiple frames for GIF, TIFF, and certain ImageMagick formats such as
4915DJVM@.
4916
4917The frames can be used either to represent multiple ``pages'' (this is
4918usually the case with multi-frame TIFF files, for example), or to
4919create animation (usually the case with multi-frame GIF files).
4920
4921A multi-frame image has a property @code{:index}, whose value is an
4922integer (counting from 0) that specifies which frame is being displayed.
4923
4924@defun image-multi-frame-p image
4925This function returns non-@code{nil} if @var{image} contains more than
4926one frame. The actual return value is a cons @code{(@var{nimages}
4927. @var{delay})}, where @var{nimages} is the number of frames and
4928@var{delay} is the delay in seconds between them, if the image itself
4929specifies a delay. Images that are intended to be animated usually
4930specify a frame delay, whereas ones that are intended to be treated as
4931multiple pages do not.
4932@end defun
4933
4934@defun image-current-frame image
4935This function returns the index of the current frame number for
4936@var{image}, counting from 0.
4937@end defun
4934 4938
4935@defun image-animated-p image 4939@defun image-show-frame image n &optional nocheck
4936This function returns non-@code{nil} if @var{image} can be animated. 4940This function switches @var{image} to frame number @var{n}. It
4937The actual return value is a cons @code{(@var{nimages} . @var{delay})}, 4941replaces a frame number outside the valid range with that of the end
4938where @var{nimages} is the number of frames and @var{delay} is the 4942of the range, unless @var{nocheck} is non-@code{nil}. If @var{image}
4939delay in seconds between them. 4943does not contain a frame with the specified number, the image displays
4944as a hollow box.
4940@end defun 4945@end defun
4941 4946
4942@defun image-animate image &optional index limit 4947@defun image-animate image &optional index limit
@@ -4948,7 +4953,9 @@ forever; if a number animation stops after that many seconds.
4948@end defun 4953@end defun
4949 4954
4950@noindent Animation operates by means of a timer. Note that Emacs imposes a 4955@noindent Animation operates by means of a timer. Note that Emacs imposes a
4951minimum frame delay of 0.01 seconds. 4956minimum frame delay of 0.01 (@code{image-minimum-frame-delay}) seconds.
4957If the image itself does not specify a delay, Emacs uses
4958@code{image-default-frame-delay}.
4952 4959
4953@defun image-animate-timer image 4960@defun image-animate-timer image
4954This function returns the timer responsible for animating @var{image}, 4961This function returns the timer responsible for animating @var{image},
diff --git a/doc/lispref/elisp.texi b/doc/lispref/elisp.texi
index 3d1c4cf577d..8ff34941b7d 100644
--- a/doc/lispref/elisp.texi
+++ b/doc/lispref/elisp.texi
@@ -1417,15 +1417,13 @@ Images
1417* Image Descriptors:: How to specify an image for use in @code{:display}. 1417* Image Descriptors:: How to specify an image for use in @code{:display}.
1418* XBM Images:: Special features for XBM format. 1418* XBM Images:: Special features for XBM format.
1419* XPM Images:: Special features for XPM format. 1419* XPM Images:: Special features for XPM format.
1420* GIF Images:: Special features for GIF format.
1421* TIFF Images:: Special features for TIFF format.
1422* PostScript Images:: Special features for PostScript format. 1420* PostScript Images:: Special features for PostScript format.
1423* ImageMagick Images:: Special features available through ImageMagick. 1421* ImageMagick Images:: Special features available through ImageMagick.
1424* Other Image Types:: Various other formats are supported. 1422* Other Image Types:: Various other formats are supported.
1425* Defining Images:: Convenient ways to define an image for later use. 1423* Defining Images:: Convenient ways to define an image for later use.
1426* Showing Images:: Convenient ways to display an image once 1424* Showing Images:: Convenient ways to display an image once
1427 it is defined. 1425 it is defined.
1428* Animated Images:: Some image formats can be animated. 1426* Multi-Frame Images:: Some images contain more than one frame.
1429* Image Cache:: Internal mechanisms of image display. 1427* Image Cache:: Internal mechanisms of image display.
1430 1428
1431Buttons 1429Buttons
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index d24f2b593d4..41eb17415b7 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -1,3 +1,8 @@
12013-02-20 Michael Albinus <michael.albinus@gmx.de>
2
3 * tramp.texi (Android shell setup): Improve. Reported by Thierry
4 Volpiatto <thierry.volpiatto@gmail.com>.
5
12013-02-16 Michael Albinus <michael.albinus@gmx.de> 62013-02-16 Michael Albinus <michael.albinus@gmx.de>
2 7
3 * tramp.texi (Top, Configuration): Insert section `Android shell 8 * tramp.texi (Top, Configuration): Insert section `Android shell
diff --git a/doc/misc/cl.texi b/doc/misc/cl.texi
index 11f19c8df06..83df411cb23 100644
--- a/doc/misc/cl.texi
+++ b/doc/misc/cl.texi
@@ -703,14 +703,6 @@ The type symbol @code{real} is a synonym for @code{number}, and
703The type symbols @code{character} and @code{string-char} match 703The type symbols @code{character} and @code{string-char} match
704integers in the range from 0 to 255. 704integers in the range from 0 to 255.
705 705
706@c No longer relevant, so covered by first item above (float -> floatp).
707@ignore
708@item
709The type symbol @code{float} uses the @code{cl-floatp-safe} predicate
710defined by this package rather than @code{floatp}, so it will work
711correctly even in Emacs versions without floating-point support.
712@end ignore
713
714@item 706@item
715The type list @code{(integer @var{low} @var{high})} represents all 707The type list @code{(integer @var{low} @var{high})} represents all
716integers between @var{low} and @var{high}, inclusive. Either bound 708integers between @var{low} and @var{high}, inclusive. Either bound
@@ -2921,14 +2913,6 @@ This predicate tests whether @var{integer} is even. It is an
2921error if the argument is not an integer. 2913error if the argument is not an integer.
2922@end defun 2914@end defun
2923 2915
2924@ignore
2925@defun cl-floatp-safe object
2926This predicate tests whether @var{object} is a floating-point
2927number. On systems that support floating-point, this is equivalent
2928to @code{floatp}. On other systems, this always returns @code{nil}.
2929@end defun
2930@end ignore
2931
2932@node Numerical Functions 2916@node Numerical Functions
2933@section Numerical Functions 2917@section Numerical Functions
2934 2918
diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi
index 77a4f632cff..807e6b4db29 100644
--- a/doc/misc/tramp.texi
+++ b/doc/misc/tramp.texi
@@ -2016,7 +2016,7 @@ local machine.
2016 2016
2017When an @command{sshd} process runs on the Android device, like 2017When an @command{sshd} process runs on the Android device, like
2018provided by the @code{SSHDroid} app, any @option{ssh}-based method can 2018provided by the @code{SSHDroid} app, any @option{ssh}-based method can
2019be used. However, this requires some special settings. 2019be used. This requires some special settings.
2020 2020
2021The default shell @code{/bin/sh} does not exist. Instead, you shall 2021The default shell @code{/bin/sh} does not exist. Instead, you shall
2022use just @code{sh}, which invokes the shell installed on the device. 2022use just @code{sh}, which invokes the shell installed on the device.
@@ -2031,23 +2031,50 @@ You can instruct @value{tramp} by this form:
2031with @samp{192.168.0.26} being the IP address of your Android device. 2031with @samp{192.168.0.26} being the IP address of your Android device.
2032 2032
2033The user settings for the @code{$PATH} environment variable must be 2033The user settings for the @code{$PATH} environment variable must be
2034preserved. Add this setting: 2034preserved. It has also been reported, that the commands in
2035@file{/system/xbin} are better suited than the ones in
2036@file{/system/bin}. Add these setting:
2035 2037
2036@lisp 2038@lisp
2037(add-to-list 'tramp-remote-path 'tramp-own-remote-path) 2039(add-to-list 'tramp-remote-path 'tramp-own-remote-path)
2040(add-to-list 'tramp-remote-path "/system/xbin")
2038@end lisp 2041@end lisp
2039 2042
2043@noindent
2040If the Android device is not @samp{rooted}, you must give the shell a 2044If the Android device is not @samp{rooted}, you must give the shell a
2041writable directory for temporary files. You could use this setting: 2045writable directory for temporary files:
2042 2046
2043@lisp 2047@lisp
2044(add-to-list 'tramp-remote-process-environment "TMPDIR=$HOME") 2048(add-to-list 'tramp-remote-process-environment "TMPDIR=$HOME")
2045@end lisp 2049@end lisp
2046 2050
2051@noindent
2047Now you shall be able to open a remote connection with @kbd{C-x C-f 2052Now you shall be able to open a remote connection with @kbd{C-x C-f
2048@trampfn{ssh, , 192.168.0.26#2222, }}, given that @command{sshd} 2053@trampfn{ssh, , 192.168.0.26#2222, }}, given that @command{sshd}
2049listens on port @samp{2222}. 2054listens on port @samp{2222}.
2050 2055
2056It is also recommended to add a corresponding entry to your
2057@file{~/.ssh/config} for that connection, like
2058
2059@example
2060Host android
2061 HostName 192.168.0.26
2062 User root
2063 Port 2222
2064@end example
2065
2066@noindent
2067In this case, you must change the setting for the remote shell to
2068
2069@lisp
2070(add-to-list 'tramp-connection-properties
2071 (list (regexp-quote "android") "remote-shell" "sh"))
2072@end lisp
2073
2074@noindent
2075You would open the connection with @kbd{C-x C-f @trampfn{ssh, ,
2076android, }} then.
2077
2051 2078
2052@node Auto-save and Backup 2079@node Auto-save and Backup
2053@section Auto-save and Backup configuration 2080@section Auto-save and Backup configuration