usr.bin/locale/locale.1

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