usr.bin/locale/locale.1

   1 .\" $NetBSD: locale.1,v 1.2 2003/07/04 07:28:14 wiz Exp $
   2 .\" $DragonFly: src/usr.bin/locale/locale.1,v 1.1 2006/07/01 10:47:39 eirikn Exp $
   3 .\"
   4 .\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
   5 .\" All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" FreeBSD: src/usr.bin/locale/locale.1,v 1.3 2003/06/26 11:01:03 phantom Exp
  29 .\"
  30 .Dd July 4, 2003
  31 .Dt LOCALE 1
  32 .Os
  33 .Sh NAME
  34 .Nm locale
  35 .Nd get locale-specific information
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl a | Fl m
  39 .Nm
  40 .Op Fl ck
  41 .Op Ar keyword ...
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 utility is supposed to provide most locale specific information to
  46 the standard output.
  47 .Pp
  48 When
  49 .Nm
  50 is invoked without arguments it will print out a summary of the
  51 current locale environment depending on environment variable settings
  52 and internal status.
  53 .Pp
  54 When
  55 .Nm
  56 is invoked with arguments and no options specified it will print out
  57 .Em keyword Ns No 's
  58 value determined using current locale settings.
  59 .Pp
  60 The following options are available:
  61 .Bl -tag -width indent
  62 .It Fl a
  63 Write names of all available locales.
  64 While looking for locales
  65 .Nm
  66 will respect the
  67 .Ev PATH_LOCALE
  68 environment variable, and use it instead of the system default
  69 locale directory.
  70 .It Fl c
  71 Write the category name for the selected keywords.
  72 .It Fl k
  73 Write the name and value of the selected keywords. The special keyword
  74 .Ar list
  75 can be used to retrieve a human readable list of available keywords.
  76 .It Fl m
  77 Write names of all available charmaps.
  78 .El
  79 .Sh EXIT STATUS
  80 .Ex -std locale
  81 .Sh STANDARDS
  82 .Nm
  83 conforms to
  84 .St -p1003.1-2001 .
  85 .Sh HISTORY
  86 .Nm
  87 first appeared in
  88 .Nx 2.0 .
  89 .Sh AUTHORS
  90 This implementation of
  91 .Nm
  92 was originally written by
  93 .An Alexey Zelkin
  94 .Aq phantom@FreeBSD.org
  95 for
  96 .Fx .
  97 .Sh BUGS
  98 Since
  99 .Nx
 100 does not support
 101 .Em charmap Ns No s
 102 in their
 103 .Em POSIX
 104 meaning
 105 .Nm
 106 emulates the
 107 .Fl m
 108 option via CODESETs listing of all available locales.