svn commit: r362708 - head/lib/libc/locale

[Joerg Wunsch]

Author: joerg
Date: Sat Jun 27 20:55:47 2020
New Revision: 362708
URL: https://svnweb.freebsd.org/changeset/base/362708

Log:
  Explain how to learn about possible recognized locale names
  
  Posix says that the interpretation of the locale string is
  "implementation-defined", so we ought to document what is
  actually recognized.
  
  Also add a cross reference to locale(1).
  
  PR:		247553
  MFC after:	1 week

Modified:
  head/lib/libc/locale/setlocale.3

Modified: head/lib/libc/locale/setlocale.3
==============================================================================
--- head/lib/libc/locale/setlocale.3	Sat Jun 27 20:01:56 2020	(r362707)
+++ head/lib/libc/locale/setlocale.3	Sat Jun 27 20:55:47 2020	(r362708)
@@ -115,9 +115,24 @@ argument of
 causes
 .Fn setlocale
 to return the current locale.
+.Pp
+The option
+.Fl a
+to the
+.Xr locale 1
+command can be used to display all further possible names for the
+.Fa locale
+argument that are recognized.
+Specifying any unrecognized value for
+.Fa locale
+makes
+.Fn setlocale
+fail.
+.Pp
 By default, C programs start in the
 .Li \&"C"
 locale.
+.Pp
 The only function in the library that sets the locale is
 .Fn setlocale ;
 the locale is never changed as a side effect of some other routine.
@@ -150,6 +165,7 @@ and the category
 .Sh ERRORS
 No errors are defined.
 .Sh SEE ALSO
+.Xr locale 1 ,
 .Xr localedef 1 ,
 .Xr catopen 3 ,
 .Xr ctype 3 ,