xref: /dragonfly/usr.bin/locale/locale.1 (revision ef2687d4)
1.\" $NetBSD: locale.1,v 1.2 2003/07/04 07:28:14 wiz 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
42The
43.Nm
44utility is supposed to provide most locale specific information to
45the standard output.
46.Pp
47When
48.Nm
49is invoked without arguments it will print out a summary of the
50current locale environment depending on environment variable settings
51and internal status.
52.Pp
53When
54.Nm
55is invoked with arguments and no options specified it will print out
56.Em keyword Ns No 's
57value determined using current locale settings.
58.Pp
59The following options are available:
60.Bl -tag -width indent
61.It Fl a
62Write names of all available locales.
63While looking for locales
64.Nm
65will respect the
66.Ev PATH_LOCALE
67environment variable, and use it instead of the system default
68locale directory.
69.It Fl c
70Write the category name for the selected keywords.
71.It Fl k
72Write the name and value of the selected keywords. The special keyword
73.Ar list
74can be used to retrieve a human readable list of available keywords.
75.It Fl m
76Write names of all available charmaps.
77.El
78.Sh EXIT STATUS
79.Ex -std locale
80.Sh STANDARDS
81.Nm
82conforms to
83.St -p1003.1-2001 .
84.Sh HISTORY
85.Nm
86first appeared in
87.Nx 2.0 .
88.Sh AUTHORS
89This implementation of
90.Nm
91was originally written by
92.An Alexey Zelkin Aq Mt phantom@FreeBSD.org
93for
94.Fx .
95.Sh BUGS
96Since
97.Nx
98does not support
99.Em charmap Ns No s
100in their
101.Em POSIX
102meaning
103.Nm
104emulates the
105.Fl m
106option via CODESETs listing of all available locales.
107