aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--lispref/text.texi9
1 files changed, 7 insertions, 2 deletions
diff --git a/lispref/text.texi b/lispref/text.texi
index 3a0d4f7a585..d506341f0d5 100644
--- a/lispref/text.texi
+++ b/lispref/text.texi
@@ -205,7 +205,7 @@ This is like @code{buffer-substring}, except that it does not copy text
205properties, just the characters themselves. @xref{Text Properties}. 205properties, just the characters themselves. @xref{Text Properties}.
206@end defun 206@end defun
207 207
208@defun filter-buffer-substring start end &optional delete 208@defun filter-buffer-substring start end &optional delete noprops
209This function passes the buffer text between @var{start} and @var{end} 209This function passes the buffer text between @var{start} and @var{end}
210through the filter functions specified by the variable 210through the filter functions specified by the variable
211@code{buffer-substring-filters}, and returns the value from the last 211@code{buffer-substring-filters}, and returns the value from the last
@@ -217,7 +217,12 @@ If @var{delete} is non-@code{nil}, this function deletes the text
217between @var{start} and @var{end} after copying it, like 217between @var{start} and @var{end} after copying it, like
218@code{delete-and-extract-region}. 218@code{delete-and-extract-region}.
219 219
220Lisp code should use this function instead of @code{buffer-substring} 220If @var{noprops} is non-@code{nil}, the final string returned does not
221include text properties, while the string passed through the filters
222still includes text properties from the buffer text.
223
224Lisp code should use this function instead of @code{buffer-substring},
225@code{buffer-substring-no-properties},
221or @code{delete-and-extract-region} when copying into user-accessible 226or @code{delete-and-extract-region} when copying into user-accessible
222data structures such as the kill-ring, X clipboard, and registers. 227data structures such as the kill-ring, X clipboard, and registers.
223Major and minor modes can add functions to 228Major and minor modes can add functions to