adv_cmds/locale/locale.1

   1 .\"Modified from man(1) of FreeBSD, the NetBSD mdoc.template, and mdoc.samples.
   2 .\"See Also:
   3 .\"man mdoc.samples for a complete listing of options
   4 .\"man mdoc for the short list of editing options
   5 .\"/usr/share/misc/mdoc.template
   6 .Dd August 27, 2004
   7 .Dt LOCALE 1
   8 .Os Darwin
   9 .Sh NAME
  10 .Nm locale
  11 .Nd display locale settings
  12 .Sh SYNOPSIS
  13 .Nm
  14 .Op Fl a|m
  15 .Nm
  16 .Op Fl ck
  17 .Ar name
  18 .Op ...
  19 .Sh DESCRIPTION
  20 .Nm
  21 displays information about the current locale, or a list of all available
  22 locales.
  23 .Pp
  24 When
  25 .Nm
  26 is run with no arguments,
  27 it will display the current source of each locale category.
  28 .Pp
  29 When
  30 .Nm
  31 is given the name of a category,
  32 it acts as if it had been given each keyword in that category.
  33 For each keyword it is given, the current value
  34 is displayed.
  35 .Sh OPTIONS
  36 .Bl -tag -width -indent
  37 .It Fl a
  38 Lists all public locales.
  39 .It Fl c Ar name ...
  40 Lists the category name before each keyword,
  41 unless it is the same category as the previously displayed keyword.
  42 .It Fl k Ar name ...
  43 Displays the name of each keyword prior to its value.
  44 .It Fl m
  45 Lists all available public charmaps.
  46 Darwin locales do not support charmaps, so list all CODESETs instead.
  47 .El
  48 .Pp
  49 .Sh OPERANDS
  50 The following operand is supported:
  51 .Pp
  52 .Ar name
  53 is the name of a keyword or category to display.  A list of all keywords
  54 and categories can be shown with the following command:
  55 .Bd -literal
  56 locale -ck LC_ALL
  57 .Ed
  58 .Pp
  59 .Sh ENVIRONMENT
  60 .Bl -tag -width "LC_MESSAGES"
  61 .It Ev LANG
  62 Used as a substitute for any unset
  63 .Ev LC_*
  64 variable.  If
  65 .Ev LANG
  66 is unset, it will act as if set to "C".  If any of
  67 .Ev LANG
  68 or
  69 .Ev LC_*
  70 are set to invalid values,
  71 .Nm
  72 acts as if they are all unset.
  73 .It Ev LC_ALL
  74 Will override the setting of all other
  75 .Ev LC_*
  76 variables.
  77 .It Ev LC_COLLATE
  78 Sets the locale for the LC_COLLATE category.
  79 .It Ev LC_CTYPE
  80 Sets the locale for the LC_CTYPE category.
  81 .It Ev LC_MESSAGES
  82 Sets the locale for the LC_MESSAGES category.
  83 .It Ev LC_MONETARY
  84 Sets the locale for the LC_MONETARY category.
  85 .It Ev LC_NUMERIC
  86 Sets the locale for the LC_NUMERIC category.
  87 .It Ev LC_TIME
  88 Sets the locale for the LC_TIME category.
  89 .El
  90 .Sh SEE ALSO
  91 .Xr localedef 1 ,
  92 .Xr localeconv 3 ,
  93 .Xr nl_langinfo 3 ,
  94 .Xr setlocale 3
  95 .Sh STANDARDS
  96 The
  97 .Nm
  98 utility conforms to IEEE Std 1003.1-2001 (``POSIX.1'').
  99 .Sh HISTORY
 100 .Nm
 101 appeared in Mac OS X 10.4