aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/strings.texi13
1 files changed, 8 insertions, 5 deletions
diff --git a/doc/lispref/strings.texi b/doc/lispref/strings.texi
index f8685d9312c..8aa4539bd78 100644
--- a/doc/lispref/strings.texi
+++ b/doc/lispref/strings.texi
@@ -465,6 +465,7 @@ Representations}.
465@code{string-equal} is another name for @code{string=}. 465@code{string-equal} is another name for @code{string=}.
466@end defun 466@end defun
467 467
468@cindex locale-dependent string equivalence
468@defun string-collate-equalp string1 string2 &optional locale ignore-case 469@defun string-collate-equalp string1 string2 &optional locale ignore-case
469This function returns @code{t} if @var{string1} and @var{string2} are 470This function returns @code{t} if @var{string1} and @var{string2} are
470equal with respect to collation rules. A collation rule is not only 471equal with respect to collation rules. A collation rule is not only
@@ -493,6 +494,7 @@ systems.
493If @var{ignore-case} is non-@code{nil}, characters are converted to lower-case 494If @var{ignore-case} is non-@code{nil}, characters are converted to lower-case
494before comparing them. 495before comparing them.
495 496
497@vindex w32-collate-ignore-punctuation
496To emulate Unicode-compliant collation on MS-Windows systems, 498To emulate Unicode-compliant collation on MS-Windows systems,
497bind @code{w32-collate-ignore-punctuation} to a non-@code{nil} value, since 499bind @code{w32-collate-ignore-punctuation} to a non-@code{nil} value, since
498the codeset part of the locale cannot be @code{"UTF-8"} on MS-Windows. 500the codeset part of the locale cannot be @code{"UTF-8"} on MS-Windows.
@@ -518,7 +520,7 @@ optional argument @var{ignore-case} is non-@code{nil}, the comparison
518ignores case differences. 520ignores case differences.
519@end defun 521@end defun
520 522
521@cindex lexical comparison 523@cindex lexical comparison of strings
522@defun string< string1 string2 524@defun string< string1 string2
523@c (findex string< causes problems for permuted index!!) 525@c (findex string< causes problems for permuted index!!)
524This function compares two strings a character at a time. It 526This function compares two strings a character at a time. It
@@ -576,6 +578,7 @@ are used.
576@code{string-lessp} is another name for @code{string<}. 578@code{string-lessp} is another name for @code{string<}.
577@end defun 579@end defun
578 580
581@cindex locale-dependent string comparison
579@defun string-collate-lessp string1 string2 &optional locale ignore-case 582@defun string-collate-lessp string1 string2 &optional locale ignore-case
580This function returns @code{t} if @var{string1} is less than 583This function returns @code{t} if @var{string1} is less than
581@var{string2} in collation order. A collation order is not only 584@var{string2} in collation order. A collation order is not only
@@ -594,15 +597,15 @@ for sorting (@pxref{Sequence Functions}):
594@end group 597@end group
595@end example 598@end example
596 599
597This behavior is system-dependent; punctuation and whitespace are 600This behavior is system-dependent; e.g., punctuation and whitespace
598never ignored on Cygwin, regardless of locale. 601are never ignored on Cygwin, regardless of locale.
599 602
600The optional argument @var{locale}, a string, overrides the setting of 603The optional argument @var{locale}, a string, overrides the setting of
601your current locale identifier for collation. The value is system 604your current locale identifier for collation. The value is system
602dependent; a @var{locale} @code{"en_US.UTF-8"} is applicable on POSIX 605dependent; a @var{locale} @code{"en_US.UTF-8"} is applicable on POSIX
603systems, while it would be, e.g., @code{"enu_USA.1252"} on MS-Windows 606systems, while it would be, e.g., @code{"enu_USA.1252"} on MS-Windows
604systems. The @var{locale} @code{"POSIX"} lets @code{string-collate-lessp} 607systems. The @var{locale} value of @code{"POSIX"} or @code{"C"} lets
605behave like @code{string-lessp}: 608@code{string-collate-lessp} behave like @code{string-lessp}:
606 609
607@example 610@example
608@group 611@group