(Special Properties): Document the meaning of the `cursor' text property

whose value is an integer.

diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 97ea2c8..1e4c99a 100644 (file)
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,8 @@
+2009-10-06  Eli Zaretskii  <eliz@gnu.org>
+
+       * text.texi (Special Properties): Document the meaning of the
+       `cursor' text property whose value is an integer.
+
 2009-10-05  Michael Albinus  <michael.albinus@gmx.de>
 
        * files.texi (Magic File Names): Add `copy-directory'.

diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi
index 89dd539..cb9636d 100644 (file)
--- a/doc/lispref/text.texi
+++ b/doc/lispref/text.texi
@@ -3168,7 +3168,11 @@ Consecutive characters with the same @code{field} property constitute a
 Normally, the cursor is displayed at the end of any overlay and text
 property strings present at the current window position.  You can
 place the cursor on any desired character of these strings by giving
-that character a non-@code{nil} @var{cursor} text property.
+that character a non-@code{nil} @code{cursor} text property.  If the
+value of the @code{cursor} property is an integer number, it specifies
+the number of buffer's character positions associated with the overlay
+or text property string; this helps Emacs display the cursor correctly
+when point moves across these character positions.
 
 @item pointer
 @kindex pointer @r{(text property)}